partner

GET `/v1/partner-consents/{token}`

Read a partner's request to act for your organization.

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/partner-consents/{token} \
  -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

For the signed-in person who followed the link in the consent e-mail. The token names the request and authorises nothing by itself: only a direct member of the organization it asks about, who already holds org.update and every permission the partner would receive there, may read or answer it — anyone else, including a member of a parent organization or an impersonated session, is a 403. An unknown, expired, superseded or answered link is a 404.

Parameters

Name	Type	Required	What it is
`token (path)`	`string`	Yes	—

Response

Name	Type	Required	What it is
`partner`	`string`	Yes	—
`customer_email`	`string`	Yes	—
`org_id`	`string`	Yes	—
`org_name`	`string`	Yes	—
`expires_at`	`string`	Yes	—
`scopes`	`string[]`	Yes	The permissions the partner would hold in this organization.

Errors this endpoint can return

401 · 403 · 404

GET /v1/partner-consents/{token}