Saltar al contenido

List ownership transfer rows

Módulo Platform

GET/ownership-transfersownershipTransfers.list

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 a cursor page of ownership transfer rows the caller may see. The default order is `offered_at` descending, newest first. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad org.members.read.
  • Alcances de OAuth: org.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

ownershipTransfers.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de OwnershipTransfer

ownershipTransfers.list: 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.
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/ownership-transfers" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.ownershipTransfers.listAll()) {
  console.log(row);
}
for row in xos.ownership_transfers.list_all():
    print(row)
xos ownership-transfers list --all