platform-transfers
GET /v1/platform-transfers
Your organisation's platform transfers.
Authentication
Send an API key as a bearer token. The key must carry the billing.view 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/platform-transfers \
-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
Every transfer in scope, newest first, each with the customer-visible part of its progress trail. Requires `billing.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
status (query) | PlatformTransferStatus | No | Only transfers in this state. |
cursor (query) | string | No | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | No | Maximum items to return (page size). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | PlatformTransfer[] | Yes | — |
next_cursor | object | No | — |
has_more | boolean | No | — |
Errors this endpoint can return
401 · 403 · 429