Skip to content
SarvexDocs
Esc
↑↓navigate↵open⌘Jpreview

List this merchant's endpoint-health alerts

GET/alerts
Authorization
AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Query parameters
cursorstring

Opaque pagination cursor from the previous page's page.cursor.

limitinteger

Maximum items per page.

min 1 · max 100 · default: 25
statusstring
Allowed:openacknowledgedresolved
severitystring
Allowed:healthydegradedcritical
store_idstring
Responses
200

Alerts.

dataalert[]required
Show properties
Array of alert
alert_idstring
store_idstring
check_typestring
severitystring
Allowed:healthydegradedcritical
statusstring
Allowed:openacknowledgedresolved
detailstring
opened_atstring<date-time>
acknowledged_atstring<date-time> | null
acknowledged_bystring
resolved_atstring<date-time> | null
auto_resolvedboolean
pagepagerequired
Show properties
cursorstring | nullrequired
has_morebooleanrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.sarvex.example.com/v1/alerts" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "alert_id": "alt_01J8Z3...",
      "store_id": "string",
      "check_type": "signature_roundtrip",
      "severity": "healthy",
      "status": "open",
      "detail": "string",
      "opened_at": "2019-08-24T14:15:22Z",
      "acknowledged_at": "2019-08-24T14:15:22Z",
      "acknowledged_by": "string",
      "resolved_at": "2019-08-24T14:15:22Z",
      "auto_resolved": true
    }
  ],
  "page": {
    "cursor": "string",
    "has_more": true
  }
}