List requisition rows
Módulo People
GET/requisitionsrequisitions.list
A staffing or purchase requisition, approved before an opportunity is published. Returns a cursor page of requisition rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad people.requisition.read.
- Alcances de OAuth: people.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| 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_]*)*$ |
| 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).Restricciones: 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. |
Respuesta 200: una página de Requisition
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the requisition. |
| 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; null when a seed, platform or system process created it. |
| 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; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Sí | Identifier of the project. |
| role_code | RoleCode | Sí | Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| requisition_state | "Proposed" | "Approved" | "Rejected" | "Filled" | "Canceled" | Sí | Requisition state. |
| scope_node_id | string (uuid) | null | Sí | Identifier of the scope node of the same project. |
| budget_line_id | string (uuid) | null | Sí | Identifier of the budget line the cost is charged to. |
| role_type | "Crew" | "Contractor" | "Staff" | "Vendor" | "Artist" | "Artist Representative" | "Client" | "Sponsor" | null | Sí | External role type an opportunity published from the requisition seeks; null when filled internally. |
| worker_classification | string | null | Sí | Worker classification, from xpms.worker_classification.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| pay_basis | string | null | Sí | Pay basis; set with the arrangement.Restricciones: length 1 to 300 |
| arrangement | string | null | Sí | Arrangement; set with the pay basis.Restricciones: length 1 to 300 |
| headcount | integer | Sí | People requested.Restricciones: range 1 to any |
| units_per_head | number | null | Sí | Pay basis units each person works, such as hours. |
| rate_minor | integer (int64) | null | Sí | Rate per pay basis unit. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Sí | ISO 4217 currency of the rate.Restricciones: pattern ^[A-Z]{3}$ |
| starts_on | string (date) | null | Sí | First day of the work. |
| ends_on | string (date) | null | Sí | Last day of the work. |
| justification | string | Sí | Why the staff are needed.Restricciones: length 1 to 2000 |
| requested_by | string (uuid) | null | Sí | Identifier of the person who requested; they cannot approve it. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"requisition_state": "Proposed",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_type": "Crew",
"worker_classification": "EMPLOYEE",
"pay_basis": "Hourly",
"arrangement": "Per Engagement",
"headcount": 12,
"units_per_head": 10,
"rate_minor": 4500,
"currency_code": "USD",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"justification": "Second stage added for the festival.",
"requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/requisitions" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.requisitions.listAll()) {
console.log(row);
}for row in xos.requisitions.list_all():
print(row)xos requisitions list --all