List opportunity alert rows

Módulo Gateway

GET/opportunity-alertsopportunityAlerts.list

An alert raised for a saved search. Returns a cursor page of opportunity alert rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad me.notifications.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

opportunityAlerts.list: 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 OpportunityAlert

opportunityAlerts.list: OpportunityAlert
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the opportunity alert.
created_at	string (date-time)	Sí	When the row was created.
updated_at	string (date-time)	Sí	When the row was last updated.
saved_search_id	string (uuid)	Sí	Identifier of the saved search.
opportunity_id	string (uuid)	Sí	Identifier of the opportunity.
delivered_at	string (date-time) \| null	Sí	When the alert was sent.
matched_at	string (date-time)	Sí	When the match was found.

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/opportunity-alerts" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.opportunityAlerts.listAll()) {
  console.log(row);
}

for row in xos.opportunity_alerts.list_all():
    print(row)

xos opportunity-alerts list --all