GET/api/v2/referrals/alert-incidents

GET /api/v2/referrals/alert-incidents

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
programId (query)string (uuid)No
status (query)stringNo
page (query)unknownNo
pageSize (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
ProgramIdstring (uuid)Yes
CurrencystringYes
KindstringYes
StatusstringYes
SeveritystringYes
ObservedValueunknownYes
SampleSizeunknownYes
OccurrenceunknownYes
OpenedAtstring (date-time)Yes
LastObservedAtstring (date-time)Yes
ResolvedAtstring (date-time)Yes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/alert-incidents" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.