Saltar al contenido

Get an ownership transfer

Módulo Platform

GET/ownership-transfers/{id}ownershipTransfers.get

An Owner's offer to hand the org to another active member (1352, Section 14.7). The member accepts with step-up (a second factor) within 7 days; the old Owner then becomes an Admin, or leaves, and the org keeps an Owner at every step. Written only by the transfer actions; audited. Returns one ownership transfer with its `ETag`. A ownership transfer the caller may not see returns 404.

  • Requiere la capacidad org.members.read.
  • Alcances de OAuth: org.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

ownershipTransfers.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the ownership transfer.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: OwnershipTransfer

ownershipTransfers.get: OwnershipTransfer
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the ownership transfer.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
from_person_idstring (uuid)SíIdentifier of the Owner who offered the org.
to_person_idstring (uuid)SíIdentifier of the member the org is offered to.
previous_owner_outcome"admin" | "leave"SíWhat happens to the Owner who offered on acceptance.
offered_atstring (date-time)SíWhen the offer was made.
expires_atstring (date-time)SíWhen an unanswered offer lapses, 7 days after it was made.
accepted_atstring (date-time) | nullSíWhen the member accepted and became an Owner.
declined_atstring (date-time) | nullSíWhen the member declined.
canceled_atstring (date-time) | nullSíWhen an Owner withdrew the offer.
canceled_bystring (uuid) | nullSíIdentifier of the Owner who withdrew it.
expired_atstring (date-time) | nullSíWhen the lifecycle job lapsed the unanswered offer.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "from_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "previous_owner_outcome": "admin",
  "offered_at": "2026-10-08T14:30:00Z",
  "expires_at": "2026-10-08T14:30:00Z",
  "accepted_at": "2026-10-08T14:30:00Z",
  "declined_at": "2026-10-08T14:30:00Z",
  "canceled_at": "2026-10-08T14:30:00Z",
  "canceled_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "expired_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/ownership-transfers/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.ownershipTransfers.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.ownership_transfers.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos ownership-transfers get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f