Get an opportunity alert
Gateway module
GET/opportunity-alerts/{id}opportunityAlerts.get
An alert raised for a saved search. Returns one opportunity alert with its `ETag`. A opportunity alert the caller may not see returns 404.
- Requires the capability me.notifications.write.
- OAuth scopes: me.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the opportunity alert. |
| 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_]*)*$ |
Response 200: OpportunityAlert
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the opportunity alert. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| saved_search_id | string (uuid) | Yes | Identifier of the saved search. |
| opportunity_id | string (uuid) | Yes | Identifier of the opportunity. |
| delivered_at | string (date-time) | null | Yes | When the alert was sent. |
| matched_at | string (date-time) | Yes | When the match was found. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"saved_search_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"delivered_at": "2026-10-08T14:30:00Z",
"matched_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/opportunity-alerts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.opportunityAlerts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.opportunity_alerts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos opportunity-alerts get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f