partner
GET /v1/partner/customers/{externalId}
Read one of your customers' links.
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} \
-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
The organization you may act on, the state of the link, and whether a registrant contact is on file yet. A customer of another partner is a 404, never a 403. Requires partner.domains.
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 |
|---|---|---|---|
external_id | string | Yes | — |
org_id | string | Yes | The organization you may act on, as X-Zinn-Org. Empty while the link is not active — a pending link names no organization you may use. |
state | string<active, pending_consent, revoked> | Yes | — |
created_org | boolean | Yes | Whether we made this organization for you, or the customer already had one. |
has_registrant | boolean | Yes | Whether a registrant contact is on file. An order is refused until it is. |
email | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429