GET /v1/transfers

Authentication

Send an API key as a bearer token. The key must carry the sites.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/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

Both directions in one list. direction is computed per request from the caller's own organizations — the same row is outgoing to one party and incoming to the other, so a stored direction would be wrong for one of its two readers. org_ids carries the caller's own organization ids. That is the value a customer gives to somebody who is transferring them a site: transfers are addressed by organization id rather than by email address, because resolving a recipient by email would turn the offer form into a way to discover whether an address has an account with us and whether it is in arrears. Requires sites.view.

Response

Errors this endpoint can return

401 · 403 · 429