List trash item rows
Platform module
GET/trashtrashItems.list
A soft-deleted row, restorable for its table's retention period. A view, not a copy. Returns a cursor page of trash item rows the caller may see. The default order is `deleted_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability work.record.read.
- OAuth scopes: work.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse 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_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter 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. |
Response 200: a page of TrashItem
| Field | Type | Required | Description |
|---|---|---|---|
| subject_urn | string | Yes | URN of the deleted row.Constraints: length 1 to 300 |
| deleted_at | string (date-time) | Yes | When it was deleted. |
| purge_after | string (date-time) | Yes | When it will be purged. |
| subject_table | string | Yes | Table of the deleted row.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| subject_id | string (uuid) | Yes | Identifier of the deleted row. |
| org_id | string (uuid) | Yes | Identifier of the org of the deleted row. |
| project_id | string (uuid) | null | Yes | Identifier of the project of the deleted row. |
| title | string | null | Yes | What the row is called.Constraints: length 1 to 300 |
| deleted_by | string (uuid) | null | Yes | Identifier of the person who deleted it. |
{
"data": [
{
"subject_urn": "urn:xpms:record:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"deleted_at": "2026-10-08T14:30:00Z",
"purge_after": "2026-10-08T14:30:00Z",
"subject_table": "budgets",
"subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Summer Series Budget",
"deleted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/trash" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.trashItems.listAll()) {
console.log(row);
}for row in xos.trash_items.list_all():
print(row)xos trash-items list --all