Saltar al contenido

List deletion certificate rows

Módulo Platform

GET/deletion-certificatesdeletionCertificates.list

The record of an org whose data was deleted (1351, Section 14.7), kept after the org is gone. Read only by the former Owner it was issued to. The PDF itself is downloaded from Atlas. Returns a cursor page of deletion certificate rows the caller may see. The default order is `due_at` descending, newest first. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad org.settings.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

deletionCertificates.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 DeletionCertificate

deletionCertificates.list: DeletionCertificate
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the deletion certificate.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
deleted_org_idstring (uuid)SíId the deleted org had.
org_namestringSíName of the org when it was deleted.Restricciones: length 1 to 300
org_slugstringSíWeb address of the org when it was deleted.Restricciones: length 1 to 100
basis"cancellation" | "deletion_request"SíDay 90 of a cancellation, or the end of a deletion request's recovery window.
requested_atstring (date-time)SíWhen the Owner canceled or asked for deletion.
due_atstring (date-time)SíWhen the data became due for deletion.
purged_atstring (date-time) | nullSíWhen every row of the org was deleted.
tables_purgedinteger | nullSíTables rows were deleted from.Restricciones: range 0 to any
rows_purgedinteger | nullSíRows deleted.Restricciones: range 0 to any
storage_objects_deletedintegerSíStored files deleted.Restricciones: range 0 to any
document_sha256string | nullSíSHA-256 of the certificate PDF.Restricciones: length 1 to 64
issued_atstring (date-time) | nullSíWhen the certificate PDF was stored.
delivered_atstring (date-time) | nullSíWhen the certificate was emailed to the former Owner.
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "updated_at": "2026-10-08T14:30:00Z",
      "deleted_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_name": "Harbor Lights Productions",
      "org_slug": "harbor-lights",
      "basis": "cancellation",
      "requested_at": "2026-10-08T14:30:00Z",
      "due_at": "2026-10-08T14:30:00Z",
      "purged_at": "2026-10-08T14:30:00Z",
      "tables_purged": 41,
      "rows_purged": 1820,
      "storage_objects_deleted": 12,
      "document_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "issued_at": "2026-10-08T14:30:00Z",
      "delivered_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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