Create a requisition
People module
POST/requisitionsrequisitions.create
A staffing or purchase requisition, approved before an opportunity is published. Creates a requisition. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability people.requisition.write.
- OAuth scopes: people.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: RequisitionCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| role_code | RoleCode | Yes | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| scope_node_id | string (uuid) | null | No | Identifier of the scope node of the same project. |
| budget_line_id | string (uuid) | null | No | Identifier of the budget line the cost is charged to. |
| role_type | "Crew" | "Contractor" | "Staff" | "Vendor" | "Artist" | "Artist Representative" | "Client" | "Sponsor" | null | No | External role type an opportunity published from the requisition seeks; null when filled internally. |
| worker_classification | string | null | No | Worker classification, from xpms.worker_classification.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| pay_basis | string | null | No | Pay basis; set with the arrangement.Constraints: length 1 to 300 |
| arrangement | string | null | No | Arrangement; set with the pay basis.Constraints: length 1 to 300 |
| headcount | integer | No | People requested.Constraints: range 1 to any |
| units_per_head | number | null | No | Pay basis units each person works, such as hours. |
| rate_minor | integer (int64) | null | No | Rate per pay basis unit. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Yes | ISO 4217 currency of the rate.Constraints: pattern ^[A-Z]{3}$ |
| starts_on | string (date) | null | No | First day of the work. |
| ends_on | string (date) | null | No | Last day of the work. |
| justification | string | Yes | Why the staff are needed.Constraints: length 1 to 2000 |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"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."
}Response 201: Requisition
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the requisition. |
| 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. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| role_code | RoleCode | Yes | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| requisition_state | "Proposed" | "Approved" | "Rejected" | "Filled" | "Canceled" | Yes | Requisition state. |
| scope_node_id | string (uuid) | null | Yes | Identifier of the scope node of the same project. |
| budget_line_id | string (uuid) | null | Yes | Identifier of the budget line the cost is charged to. |
| role_type | "Crew" | "Contractor" | "Staff" | "Vendor" | "Artist" | "Artist Representative" | "Client" | "Sponsor" | null | Yes | External role type an opportunity published from the requisition seeks; null when filled internally. |
| worker_classification | string | null | Yes | Worker classification, from xpms.worker_classification.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| pay_basis | string | null | Yes | Pay basis; set with the arrangement.Constraints: length 1 to 300 |
| arrangement | string | null | Yes | Arrangement; set with the pay basis.Constraints: length 1 to 300 |
| headcount | integer | Yes | People requested.Constraints: range 1 to any |
| units_per_head | number | null | Yes | Pay basis units each person works, such as hours. |
| rate_minor | integer (int64) | null | Yes | Rate per pay basis unit. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Yes | ISO 4217 currency of the rate.Constraints: pattern ^[A-Z]{3}$ |
| starts_on | string (date) | null | Yes | First day of the work. |
| ends_on | string (date) | null | Yes | Last day of the work. |
| justification | string | Yes | Why the staff are needed.Constraints: length 1 to 2000 |
| requested_by | string (uuid) | null | Yes | Identifier of the person who requested; they cannot approve 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",
"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"
}Code samples
curl -X POST "$XOS_BASE_URL/requisitions" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_code":"5000.50.01","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."}'const { data } = await xos.requisitions.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_code": "5000.50.01",
"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."
});response = xos.requisitions.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "role_code": "5000.50.01", "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."})xos requisitions create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_code":"5000.50.01","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."}'