access

GET /v1/access/impersonation/current

The current impersonation status (drives the banner).

All access endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/access/impersonation/current \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Whether the calling session is an impersonation, and if so who (the real staff actor), which org, and when it expires — the source for the non-dismissable "you are viewing as <customer>" banner. Any authenticated caller may ask; a normal session gets `active: false`.

Response

NameTypeRequiredWhat it is
activebooleanYes
actorstringNoThe real staff actor (`user:<id>`) when active.
org_idstringNo
org_namestringNo
expires_atstringNo
session_idstringNo

Errors this endpoint can return

401 · 429