partner
GET /v1/partner/events
Poll what happened to your customers' orders and domains.
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/events \
-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
Oldest first, strictly after after (the next_cursor of your previous page; omit it to start from the beginning). Only customers whose link is active are included; order events cover only orders you placed; domain events cover every domain in a linked organization. Events are released 30 seconds after they are written so a slow transaction cannot land behind your cursor — delivery is at least once, so de-duplicate on id. A page can be shorter than limit and still have has_more: true. Webhooks are not offered yet. Requires partner.domains.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
after (query) | string | No | — |
limit (query) | integer | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
events | PartnerEvent[] | Yes | — |
next_cursor | string | Yes | Pass as after next time. Unchanged when the page is empty. |
has_more | boolean | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429