partner
GET /v1/partner/customers/{externalId}/panel-access
Whether your customer can sign in to their control panel yet.
Authentication
Send an API key as a bearer token. The key must carry the partner.domains permission; a key without it is refused with 403, not 404.
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/partner/customers/{externalId}/panel-access \
-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
Read-only. member is true once a user with the e-mail the customer is linked with belongs to the customer's organization. invitation is the newest control-panel invitation for that e-mail (expired when a pending one has passed its expires_at), or null when none was ever sent — send panel-invite. panel_url is the address the customer bookmarks. Requires partner.domains; an unknown or inactive customer is 404. Not audited (it changes nothing).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
externalId (path) | string | Yes | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
member | boolean | Yes | The linked e-mail already belongs to the customer's organization. |
email | string | Yes | — |
panel_url | string | Yes | The control-panel address to give the customer. |
invitation | null | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429