List opportunity rows
Módulo Opportunities
GET/opportunitiesopportunities.list
An opportunity published from an approved requisition. Without posted compensation it shows Rate on Request, never zero. Returns a cursor page of opportunity rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad opportunities.posting.read.
- Alcances de OAuth: opportunities.
- 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 Opportunity
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the opportunity. |
| 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. |
| requisition_id | string (uuid) | null | Sí | Identifier of the approved requisition the opportunity is published from; required to publish Contractor, Crew and Staff opportunities and fixed once published. |
| project_id | string (uuid) | Sí | Identifier of the project. |
| scope_node_id | string (uuid) | null | Sí | Identifier of the scope node. |
| title | string | Sí | Opportunity title, Title Case.Restricciones: length 1 to 300 |
| role_type | ExternalRoleType | Sí | External role type (Section 4.4.2).Restricciones: one of "Client", "Vendor", "Contractor", "Crew", "Staff", "Artist", "Artist Representative", "Sponsor" |
| role_code | RoleCode | null | Sí | |
| cat_urid | UridAtAnyGrain | Sí | URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$ |
| description | string | null | Sí | Description.Restricciones: length 1 to 20000 |
| venue_id | string (uuid) | null | Sí | Identifier of the venue. |
| rate_type | RateType | null | Sí | |
| visibility | OpportunityVisibility | Sí | Who can see an opportunity.Restricciones: one of "Invited", "Pool", "Network", "Public" |
| opportunity_state | OpportunityState | Sí | Opportunity lifecycle state.Restricciones: one of "Draft", "Pending Approval", "Published", "Paused", "Filled", "Closed", "Canceled" |
| jurisdiction_id | JurisdictionId | null | Sí | |
| starts_on | string (date) | null | Sí | First day of the work. |
| ends_on | string (date) | null | Sí | Last day of the work. |
| pay_min_minor | integer (int64) | null | Sí | Lower end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero. |
| pay_max_minor | integer (int64) | null | Sí | Upper end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Sí | ISO 4217 currency of the posted pay.Restricciones: pattern ^[A-Z]{3}$ |
| deadline_at | string (date-time) | null | Sí | Deadline for applications and bids. Bids stay sealed until it passes. |
| minimum_age | integer | null | Sí | Minimum age for the work, 16 or older (Section 14.9).Restricciones: range 16 to any |
| is_remote | boolean | Sí | Whether the work can be done remotely. |
{
"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",
"requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Stagehands for Harborfront Load-In",
"role_type": "Crew",
"role_code": "5000.50.01",
"cat_urid": "4000.01",
"description": "Six stagehands for a two-day load-in.",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_type": "Day",
"visibility": "Pool",
"opportunity_state": "Published",
"jurisdiction_id": "US-FL",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"pay_min_minor": 3500,
"pay_max_minor": 4500,
"currency_code": "USD",
"deadline_at": "2026-10-08T14:30:00Z",
"minimum_age": 18,
"is_remote": false
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/opportunities" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.opportunities.listAll()) {
console.log(row);
}for row in xos.opportunities.list_all():
print(row)xos opportunities list --all