hosting
GET /v1/sites/{siteId}/transfer
Get this site's most recent transfer offer.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/transfer \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_name | string | Non | 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 | Non | The site's domain as it was when the offer was made. Snapshotted, as above. |
direction | string<incoming, outgoing> | Oui | 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> | Oui | 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 | Oui | Whether the domain, its DNS and its mail travel with the site. |
recipient_email | string | Non | 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 | Non | — |
expires_at | string | Oui | An unaccepted offer expires fourteen days after it is made. |
term_ends_at | string | Non | — |
renewal_amount_minor | integer | Non | — |
renewal_currency | string | Non | — |
created_at | string | Oui | — |
decided_at | string | Non | — |
failure_reason | string | Non | Why a `failed` transfer could not complete. Empty otherwise. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429