List engagement rows
Opportunities module
GET/engagementsengagements.list
An external relationship: a person or external account working for an org. It cannot become Active until every blocking onboarding item passes. Returns a cursor page of engagement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability opportunities.engagement.read.
- OAuth scopes: opportunities.
- 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 Engagement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the engagement. |
| 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. |
| person_id | string (uuid) | null | Yes | Identifier of the engaged person. |
| organization_id | string (uuid) | null | Yes | Identifier of the engaged external account. |
| project_id | string (uuid) | null | Yes | Identifier of the project. |
| offer_id | string (uuid) | null | Yes | Identifier of the accepted offer. |
| role_type | ExternalRoleType | Yes | External role type (Section 4.4.2).Constraints: one of "Client", "Vendor", "Contractor", "Crew", "Staff", "Artist", "Artist Representative", "Sponsor" |
| engagement_state | EngagementState | Yes | Engagement lifecycle state. Active requires every blocking onboarding item to pass.Constraints: one of "Onboarding", "Blocked", "Active", "Closing", "Complete", "Canceled" |
| activated_at | string (date-time) | null | Yes | When it became Active. |
| completed_at | string (date-time) | null | Yes | When it became Complete. |
| application_id | string (uuid) | null | Yes | Identifier of the accepted application the engagement came from. |
| worker_classification | string | null | Yes | Worker classification, from xpms.worker_classification; null for Client and Sponsor engagements.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| pay_basis | string | null | Yes | Pay basis; with the arrangement a permitted canon pair.Constraints: length 1 to 300 |
| arrangement | string | null | Yes | Arrangement; with the pay basis a permitted canon pair.Constraints: length 1 to 300 |
| start_date | string (date) | Yes | First day of the engagement; defaults to the offer's or the opportunity's. |
| end_date | string (date) | null | Yes | Last day of the engagement; defaults to the offer's or the opportunity's. |
| counterparty_id | string (uuid) | null | Yes | Identifier of the counterparty (vendor) the holder is engaged through; null when direct. |
{
"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",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"offer_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_type": "Crew",
"engagement_state": "Onboarding",
"activated_at": "2026-10-08T14:30:00Z",
"completed_at": "2026-10-08T14:30:00Z",
"application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"worker_classification": "INDEPENDENT_CONTRACTOR",
"pay_basis": "Day Rate",
"arrangement": "Per Engagement",
"start_date": "2026-10-08",
"end_date": "2026-10-08",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/engagements" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.engagements.listAll()) {
console.log(row);
}for row in xos.engagements.list_all():
print(row)xos engagements list --all