List requirement rows
Places module
GET/requirementsrequirements.list
A requirement or a capability: one shape with a direction facet, so reconciliation is a join. Returns a cursor page of requirement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability projects.project.read.
- OAuth scopes: projects.
- 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 Requirement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the requirement. |
| 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. |
| direction | "Require" | "Provide" | Yes | Require for a requirement of the project, Provide for a capability a venue or counterparty offers. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| venue_id | string (uuid) | null | Yes | Identifier of the venue. |
| 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}$ |
| description | string | Yes | What is required or provided.Constraints: length 1 to 20000 |
| quantity | number | null | Yes | Quantity required or provided. |
| unit_basis | UnitCode | Yes | Unit basis from the controlled unit list in `xpms.dim_unit_alias`.Constraints: pattern ^[a-z][a-z0-9_-]*$ |
| is_critical | boolean | Yes | Whether the requirement is critical. |
| counterparty_id | string (uuid) | null | Yes | Identifier of the counterparty that provides a capability. |
| assertion_word | "CERTIFIED" | "DOCUMENTED" | "CLAIMED" | "INFERRED" | "UNKNOWN" | Yes | Canon capability assertion word (Bible tab 22); silence is UNKNOWN, which reconciles as Unknown. |
{
"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",
"direction": "Require",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"urid": "4000.01",
"description": "Three-phase 400 A power at stage left.",
"quantity": 1,
"unit_basis": "each",
"is_critical": true,
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"assertion_word": "DOCUMENTED"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/requirements" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.requirements.listAll()) {
console.log(row);
}for row in xos.requirements.list_all():
print(row)xos requirements list --all