認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/transfers \
-H "Authorization: Bearer zdk_live_…"ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
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`.
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
transfers | SiteTransfer[] | はい | — |
org_ids | Uuid[] | はい | The caller's own organization ids — what they give to somebody transferring them a site. See `SiteTransferProposal.target_org_id` for why transfers are addressed this way. |
このエンドポイントが返すエラー
401 · 403 · 429