Skip to content

List code alerts

Department code alerts (default: active). `area` is omitted when the site turns `integration.api.includeCodeArea` off.

GET
/v1/codes

Department code alerts (default: active). area is omitted when the site turns integration.api.includeCodeArea off.

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: codes:read

Query Parameters

calledSince?string

RFC 3339 timestamp with an explicit offset (Z or ±hh:mm). A timestamp without an offset is refused.

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,9})?(?:Z|[+-]\d{2}:\d{2})$
Formatdate-time
Lengthlength <= 40
cursor?string

Opaque cursor from nextCursor. Bound to the query's filters and valid for 24 hours.

Match^cur_[A-Za-z0-9_-]{8,2048}$
limit?integer

Page size, 1 to 100 (default 25).

Range1 <= value <= 100
site?string

A site's code (its slug), for example kb-main-ed.

Match^[a-z0-9][a-z0-9-]{1,62}$
state?string

Value in

  • "pending_confirmation"
  • "active"
  • "active_staff_only"
  • "cleared"
  • "expired"
  • "cancelled"
updatedSince?string

RFC 3339 timestamp with an explicit offset (Z or ±hh:mm). A timestamp without an offset is refused.

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,9})?(?:Z|[+-]\d{2}:\d{2})$
Formatdate-time
Lengthlength <= 40

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/codes"
{  "data": [    {      "area": "string",      "calledAt": "2026-09-14T15:00:11.402Z",      "category": "medical",      "clearedAt": "2026-09-14T15:00:11.402Z",      "expiresAt": "2026-09-14T15:00:11.402Z",      "id": "code_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",      "object": "code_alert",      "patientNotice": true,      "severity": "advisory",      "site": "kb-main-ed",      "source": "console",      "state": "pending_confirmation",      "type": "string",      "updatedAt": "2026-09-14T15:00:11.402Z",      "version": -9007199254740991    }  ],  "hasMore": true,  "nextCursor": "string",  "object": "list"}

Was this page helpful?