hosting
GET /v1/sites/{siteId}/transfer
Get this site's most recent transfer offer.
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/sites/{siteId}/transfer \
-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 latest offer for this site, in any state, so the site page can show either a pending handover or the outcome of the last one. `404` when the site has never been offered. Requires `sites.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_name | string | No | The site's name as it was when the offer was made. Snapshotted onto the offer, not read live: while a transfer is pending the site still belongs to the sender, and reading it li… |
primary_domain | string | No | The site's domain as it was when the offer was made. Snapshotted, as above. |
direction | string<incoming, outgoing> | Yes | From **this caller's** point of view. Computed per request, never stored — the same row is outgoing to one party and incoming to the other. |
status | string<pending, accepted, declined, cancelled, expired, failed> | Yes | Five terminal states rather than one, because *why* an offer ended is what support is actually asked. `failed` means it was accepted and could not complete; nothing moved. |
include_domain | boolean | Yes | Whether the domain, its DNS and its mail travel with the site. |
recipient_email | string | No | Only populated for the **sender**. To the receiver it is their own address and carries no information; to anyone else it would be a third party's email address in a row two orga… |
message | string | No | — |
expires_at | string | Yes | An unaccepted offer expires fourteen days after it is made. |
term_ends_at | string | No | — |
renewal_amount_minor | integer | No | — |
renewal_currency | string | No | — |
created_at | string | Yes | — |
decided_at | string | No | — |
failure_reason | string | No | Why a `failed` transfer could not complete. Empty otherwise. |
Errors this endpoint can return
401 · 403 · 404 · 429