Passer au contenu

List requests

The requests feed, ordered by `(updatedAt, id)`, with the 10-second settle window. Only requests past the patient's undo window appear.

Cette page n'est pas encore offerte en français; elle est affichée en anglais.
GET
/v1/requests

The requests feed, ordered by (updatedAt, id), with the 10-second settle window. Only requests past the patient's undo window appear.

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: requests:read

Query Parameters

category?string

Value in

  • "location"
  • "need"
  • "question"
  • "urgent"
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}$
encounterId?string

An opaque enc_ id.

Match^enc_[0-9A-Za-z]{16,64}$
limit?integer

Page size, 1 to 100 (default 25).

Range1 <= value <= 100
priority?string

Value in

  • "low"
  • "normal"
  • "high"
  • "urgent"
site?string

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

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

Lifecycle state of a patient request.

Value in

  • "open"
  • "acknowledged"
  • "going_now"
  • "resolved"
  • "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/requests"
{  "data": [    {      "acknowledgedAt": "2026-09-14T15:00:11.402Z",      "acknowledgedBy": {        "appId": "app_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",        "kind": "staff",        "practitioner": {          "display": "string",          "identifiers": [            {              "externalId": "string",              "idSystem": "string"            }          ]        }      },      "category": "location",      "createdAt": "2026-09-14T15:00:11.402Z",      "encounterId": "enc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",      "escalationLevel": 0,      "id": "req_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",      "label": {        "en": "string",        "fr": "string"      },      "object": "request",      "outcome": "done",      "priority": "low",      "resolvedAt": "2026-09-14T15:00:11.402Z",      "routedTo": {        "kind": "string"      },      "site": "kb-main-ed",      "status": "open",      "type": "string",      "updatedAt": "2026-09-14T15:00:11.402Z",      "version": -9007199254740991    }  ],  "hasMore": true,  "nextCursor": "string",  "object": "list"}

Cette page vous a-t-elle été utile?