Create a saved search
Gateway module
POST/saved-searchessavedSearches.create
A saved marketplace search that sends alerts. Creates a saved search. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability me.profile.write.
- OAuth scopes: me.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: SavedSearchCreate
| Field | Type | Required | Description |
|---|---|---|---|
| person_id | string (uuid) | Yes | Identifier of the owner. |
| name | string | Yes | Search name.Constraints: length 1 to 300 |
| alerts_enabled | boolean | No | Whether alerts are sent by email and push. |
| role_type | ExternalRoleType | null | No | |
| role_code | RoleCode | null | No | |
| cat_urid | UridAtAnyGrain | null | No | |
| jurisdiction_id | JurisdictionId | null | No | |
| starts_after | string (date) | null | No | Earliest start date. |
| ends_before | string (date) | null | No | Latest end date. |
| min_rate_minor | integer (int64) | null | No | Minimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | No | ISO 4217 currency of the minimum pay.Constraints: pattern ^[A-Z]{3}$ |
{
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Miami Rigging Calls",
"alerts_enabled": true,
"starts_after": "2026-10-08",
"ends_before": "2026-10-08",
"min_rate_minor": 3500,
"currency_code": "USD"
}Response 201: SavedSearch
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the saved search. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| person_id | string (uuid) | Yes | Identifier of the owner. |
| name | string | Yes | Search name.Constraints: length 1 to 300 |
| alerts_enabled | boolean | Yes | Whether alerts are sent by email and push. |
| role_type | ExternalRoleType | null | Yes | |
| role_code | RoleCode | null | Yes | |
| cat_urid | UridAtAnyGrain | null | Yes | |
| jurisdiction_id | JurisdictionId | null | Yes | |
| starts_after | string (date) | null | Yes | Earliest start date. |
| ends_before | string (date) | null | Yes | Latest end date. |
| min_rate_minor | integer (int64) | null | Yes | Minimum posted pay. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the minimum pay.Constraints: 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"
}Code samples
curl -X POST "$XOS_BASE_URL/saved-searches" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Miami Rigging Calls","alerts_enabled":true,"starts_after":"2026-10-08","ends_before":"2026-10-08","min_rate_minor":3500,"currency_code":"USD"}'const { data } = await xos.savedSearches.create({
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Miami Rigging Calls",
"alerts_enabled": true,
"starts_after": "2026-10-08",
"ends_before": "2026-10-08",
"min_rate_minor": 3500,
"currency_code": "USD"
});response = xos.saved_searches.create({"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "name": "Miami Rigging Calls", "alerts_enabled": True, "starts_after": "2026-10-08", "ends_before": "2026-10-08", "min_rate_minor": 3500, "currency_code": "USD"})xos saved-searches create --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Miami Rigging Calls","alerts_enabled":true,"starts_after":"2026-10-08","ends_before":"2026-10-08","min_rate_minor":3500,"currency_code":"USD"}'