List onboarding requirement rows
Opportunities module
GET/onboarding-requirementsonboardingRequirements.list
A requirement of the onboarding packet, by role type and jurisdiction. Returns a cursor page of onboarding requirement 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 OnboardingRequirement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the onboarding 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. |
| role_type | ExternalRoleType | null | Yes | |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| verification_method | string | Yes | Verification method. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| name | string | Yes | Requirement name, for example Certificate of Insurance.Constraints: length 1 to 300 |
| item_kind | "Document Upload" | "Electronic Signature" | "Form" | "Certification" | "Training" | "Acknowledgment" | "Background Check" | "Tax Form" | "Payout Details" | Yes | Kind of onboarding item. |
| is_blocking | boolean | Yes | True when the engagement cannot become Active until the item passes. |
| valid_for_days | integer | null | Yes | Days a verification stays valid; null when it does not expire.Constraints: range 1 to any |
| remind_days_before | integer | null | Yes | Days before expiry the party is reminded.Constraints: range 1 to any |
{
"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",
"role_type": "Crew",
"jurisdiction_id": "US-FL",
"verification_method": "Reviewer",
"name": "Certificate of Insurance",
"item_kind": "Document Upload",
"is_blocking": true,
"valid_for_days": 365,
"remind_days_before": 30
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/onboarding-requirements" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.onboardingRequirements.listAll()) {
console.log(row);
}for row in xos.onboarding_requirements.list_all():
print(row)xos onboarding-requirements list --all