access
GET /v1/access/impersonation/current
The current impersonation status (drives the banner).
Authentication
Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.
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
| Name | Type | Required | What it is |
|---|---|---|---|
active | boolean | Yes | — |
actor | string | No | The real staff actor (user:<id>) when active. |
actor_email | string | No | The staff actor's e-mail, so the banner names a person rather than an id. Empty when inactive or when the actor is not a user. |
org_id | string | No | — |
org_name | string | No | — |
expires_at | string | No | — |
session_id | string | No | — |
kind | string<support, delegated_sign_in> | No | support — a staff member is viewing the customer's account (the non-dismissable staff banner). delegated_sign_in — the customer's OWN sign-in, handed over by the partner or… |
delegated_by | string | No | The partner's (or reseller's) name for delegated_sign_in, else "". |
delegated_return_url | string | No | For a partner's delegated_sign_in: the way back to the partner's own app (https, the partner's first registered return host, path /), shown as "Back to" and the partner's… |
Errors this endpoint can return
401 · 429