List record rows
Work module
GET/recordsrecords.list
A record of any of the 26 kinds. Kind-specific attributes live in 1:1 extension tables keyed by `record_id`. Returns a cursor page of record rows the caller may see. The default order is `created_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 Record
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the record. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| record_key | string | Yes | Display key issued by `next_sequence`.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| record_kind | RecordKind | Yes | Record kind from `xpms.dim_record_kind` (26 kinds, Section 3.10).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| record_subtype | RecordSubtype | Yes | Kind-scoped record subtype from `xpms.dim_record_subtype`. A subtype of one kind cannot be stored on another.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| record_class | RecordClass | Yes | Record class from `xpms.dim_record_kind`, derived from the kind.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| record_state | RecordState | Yes | Record state (Section 3.10). Blocked names its blocker, Deferred carries a replan reason, Canceled is retained.Constraints: one of "Proposed", "Ready", "Scheduled", "Active", "Blocked", "In Review", "Complete", "Deferred", "Canceled" |
| title | string | Yes | Title, validated against the kind's title grammar on write.Constraints: length 1 to 300 |
| scope_node_id | string (uuid) | Yes | Identifier of the scope node. |
| phase_code | PhaseCode | Yes | Phase code from `xpms.dim_phase`, ordered by gate ordinal.Constraints: pattern ^[A-Z]{3}$ |
| urid | UridAtAnyGrain | Yes | URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$ |
| xyz | Xyz | Yes | XYZ schema-family tag (Section 3.6): X Resource, Y Process, Z Timeline.Constraints: pattern ^[XYZ]$ |
| owner_party_id | string (uuid) | null | Yes | Identifier of the owning person or organization. |
| accountable_party_id | string (uuid) | null | Yes | Identifier of the accountable person or organization. |
| starts_at | string (date-time) | null | Yes | Start of the record window. |
| ends_at | string (date-time) | null | Yes | End of the record window. |
| due_at | string (date-time) | null | Yes | Due instant. |
| blocker_text | string | null | Yes | The named blocker; required when Blocked.Constraints: length 1 to 20000 |
| replan_reason | string | null | Yes | Replan reason; required when Deferred.Constraints: length 1 to 20000 |
| external_visibility | array of ExternalRoleType | Yes | External role types that may see the record; empty means internal only. Stored as junction rows, presented as a set. |
| project_id | string (uuid) | Yes | Identifier of the project the record belongs to, derived from its scope node and never changed. |
| parent_record_id | string (uuid) | null | Yes | Identifier of the summary record this record rolls up to, in the same project. |
| wbs_code | string | null | Yes | Work breakdown structure code, dot separated.Constraints: pattern ^[0-9]+(\.[0-9]+)*$; length 1 to 50 |
| description | string | null | Yes | What the record involves, in sentence case.Constraints: length 1 to 4000 |
| sop_id | string (uuid) | null | Yes | Identifier of the standard operating procedure that governs the work. |
| team_code | TeamId | null | Yes | |
| assignee_membership_ids | array of string (uuid) | Yes | Memberships assigned to the record (app.record_assignments), oldest first. |
| progress_pct | number | null | Yes | Progress of a task record, as a percentage.Constraints: range 0 to 100 |
| permit_identifier | string | null | Yes | Permit identifier the authority issued, on a permit record.Constraints: length 1 to 200 |
| inspection_result_enum_id | string (uuid) | null | Yes | Identifier of the Inspection Result enumeration row (Standard Library) of an inspection record. |
{
"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",
"record_key": "NWL-24-118",
"record_kind": "Task",
"record_subtype": "Design",
"record_class": "Work",
"record_state": "Scheduled",
"title": "Install Main Stage Truss",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"phase_code": "SCP",
"urid": "4000.01",
"xyz": "X",
"owner_party_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"accountable_party_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"due_at": "2026-10-08T14:30:00Z",
"blocker_text": "Waiting on the rigging plot.",
"replan_reason": "Moved to the second weekend.",
"external_visibility": [
"Vendor"
],
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"parent_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"wbs_code": "1.2.1",
"description": "Rig the downstage truss.",
"sop_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"team_code": "4000-T01",
"assignee_membership_ids": [
"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
],
"progress_pct": 40,
"permit_identifier": "BP-2027-0611",
"inspection_result_enum_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/records" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.records.listAll()) {
console.log(row);
}for row in xos.records.list_all():
print(row)xos records list --all