Get an org deletion request
Módulo Platform
GET/org-deletion-requests/{id}orgDeletionRequests.get
An Owner's request to delete the org (1351, Section 14.7), separate from cancellation: made with step-up and the typed name, it ends the subscription and makes the org read-only at once; an Owner may recover it for 7 days, after which the data is deleted and the Owner receives a deletion certificate. Returns one org deletion request with its `ETag`. A org deletion request the caller may not see returns 404.
- Requiere la capacidad org.settings.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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the org deletion request. |
| fields | Fields | No | Sparse 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: OrgDeletionRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the org deletion request. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row. |
| reason | string | Sí | Why the org is deleted, in the Owner's words.Restricciones: length 1 to 20000 |
| requested_at | string (date-time) | Sí | When the Owner asked for deletion. |
| recover_until | string (date-time) | Sí | End of the 7-day recovery window. |
| requested_by | string (uuid) | Sí | Identifier of the Owner who asked for deletion. |
| recovered_at | string (date-time) | null | Sí | When an Owner recovered the org. |
| recovered_by | string (uuid) | null | Sí | Identifier of the Owner who recovered it. |
{
"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",
"reason": "We are closing down.",
"requested_at": "2026-10-08T14:30:00Z",
"recover_until": "2026-10-08T14:30:00Z",
"requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"recovered_at": "2026-10-08T14:30:00Z",
"recovered_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/org-deletion-requests/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.orgDeletionRequests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.org_deletion_requests.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos org-deletion-requests get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f