Skip to content

Get an org deletion request

Platform module

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.

  • Requires the capability org.settings.read.
  • OAuth scopes: org.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

orgDeletionRequests.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the org deletion request.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: OrgDeletionRequest

orgDeletionRequests.get: OrgDeletionRequest
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the org deletion request.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
reasonstringYesWhy the org is deleted, in the Owner's words.Constraints: length 1 to 20000
requested_atstring (date-time)YesWhen the Owner asked for deletion.
recover_untilstring (date-time)YesEnd of the 7-day recovery window.
requested_bystring (uuid)YesIdentifier of the Owner who asked for deletion.
recovered_atstring (date-time) | nullYesWhen an Owner recovered the org.
recovered_bystring (uuid) | nullYesIdentifier 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"
}

Code samples

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