TracePass
Access grants

Read an access grant

One grant of your company, live, expired or revoked. The state field says which. The response never carries the token or any part of it.

GET/api/v1/access-grants/{id}
Download OpenAPI 3.1
GET/api/v1/access-grants/{id}

Read an access grant

One grant of your company, live, expired or revoked. The state field says which. The response never carries the token or any part of it.

An id that belongs to another company answers 404, exactly as an id that does not exist, and reveals nothing about it.

Who may call it. An API key only when its owner switched on "May manage access grants" for that key on the Developer page (off by default; otherwise 403 access_grants_not_enabled). An OAuth token needs the access_grants:read scope and an editor role or above.

Path parameters

  • idrequired

    string (24 hex chars)

    Access grant ID.

Headers

  • Authorizationrequired

    string

    Bearer <token> — either a tp_ API key (Developer → API Keys; simplest, for server-to-server) or an OAuth 2.0 access token (Developer → OAuth Apps; for user-authorized apps, scoped + revocable). The Authentication page has the full OAuth flow and scope list.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

Request

curl -sS https://app.tracepass.eu/api/v1/access-grants/6650c1d2e3f4a5b6c7d8e9f0 \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx"

Response

{
  "data": {
    "id": "6650c1d2e3f4a5b6c7d8e9f0",
    "accessLevel": "restricted",
    "label": "Buyer GmbH, order 4711",
    "role": "purchaser",
    "scope": { "kind": "passports", "ids": ["6650a1b2c3d4e5f6a7b8c9d0"] },
    "purpose": null,
    "evidence": null,
    "state": "active",
    "expiresAt": null,
    "useCount": 0,
    "createdAt": "2026-06-01T09:30:00.000Z"
  }
}