身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/transfer \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_name | string | 否 | 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 | 否 | The site's domain as it was when the offer was made. Snapshotted, as above. |
direction | string<incoming, outgoing> | 是 | 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> | 是 | 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 | 是 | Whether the domain, its DNS and its mail travel with the site. |
recipient_email | string | 否 | 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 | 否 | — |
expires_at | string | 是 | An unaccepted offer expires fourteen days after it is made. |
term_ends_at | string | 否 | — |
renewal_amount_minor | integer | 否 | — |
renewal_currency | string | 否 | — |
created_at | string | 是 | — |
decided_at | string | 否 | — |
failure_reason | string | 否 | Why a `failed` transfer could not complete. Empty otherwise. |
此端点可能返回的错误
401 · 403 · 404 · 429