Get a saved search
Módulo Gateway
GET/saved-searches/{id}savedSearches.get
A saved marketplace search that sends alerts. Returns one saved search with its `ETag`. A saved search the caller may not see returns 404.
- Requiere la capacidad me.profile.write.
- Alcances de OAuth: me.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the saved search. |
| 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_]*)*$ |
Respuesta 200: 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}$ |
{
"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"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/saved-searches/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.savedSearches.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.saved_searches.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos saved-searches get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f