List saved search rows
Módulo Gateway
GET/saved-searchessavedSearches.list
A saved marketplace search that sends alerts. Returns a cursor page of saved search rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad me.profile.write.
- Alcances de OAuth: me.
- 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 SavedSearch
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the saved search. |
| created_at | string (date-time) | Sí | When the row was created. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| person_id | string (uuid) | Sí | Identifier of the owner. |
| name | string | Sí | Search name.Restricciones: length 1 to 300 |
| alerts_enabled | boolean | Sí | Whether alerts are sent by email and push. |
| role_type | ExternalRoleType | null | Sí | |
| role_code | RoleCode | null | Sí | |
| cat_urid | UridAtAnyGrain | null | Sí | |
| jurisdiction_id | JurisdictionId | null | Sí | |
| starts_after | string (date) | null | Sí | Earliest start date. |
| ends_before | string (date) | null | Sí | Latest end date. |
| min_rate_minor | integer (int64) | null | Sí | Minimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Sí | ISO 4217 currency of the minimum pay.Restricciones: pattern ^[A-Z]{3}$ |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Miami Rigging Calls",
"alerts_enabled": true,
"role_type": "Crew",
"role_code": "5000.50.01",
"cat_urid": "4000.01",
"jurisdiction_id": "US-FL",
"starts_after": "2026-10-08",
"ends_before": "2026-10-08",
"min_rate_minor": 3500,
"currency_code": "USD"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/saved-searches" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.savedSearches.listAll()) {
console.log(row);
}for row in xos.saved_searches.list_all():
print(row)xos saved-searches list --all