List alerts

get/v1/alerts

Returns a page of alerts. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff and caregivers.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

Query parameters

limit

integerdefault: 25min 1max 100

Number of objects to return, from 1 to 100.

cursor

string

The next_cursor from the previous page. Send the same filters with it.

type

string

Only return alerts of this type.

One ofCriticalImportantNotice

audience

string

Only return alerts for this audience.

One ofCompanyWideStaffOnlyCaregiversAllPatientsAllCaregiverPatientVisitPatientCareTeam

created_after

string · date-time

Only return objects created after this time (exclusive). ISO 8601 with a time zone.

created_before

string · date-time

Only return objects created before this time (exclusive). ISO 8601 with a time zone.

updated_after

string · date-time

Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.

updated_before

string · date-time

Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.

Response

200

A page of results.

object

string

Always list.

data

array of objects

The alerts on this page.

Show item attributesHide item attributes(11)

object

stringrequiredread-only

String representing the object's type. Always alert.

stringrequiredread-only

Unique identifier of the alert.

name

string | nullrequiredmax length 200

Headline.

description

string | nullrequiredmax length 20000

Details.

type

string | nullrequired

How prominently the alert is shown.

One ofCriticalImportantNoticenull

audience

string | nullrequired

Who sees the alert. Caregiver, Patient, Visit and PatientCareTeam need audienceTargetId.

One ofCompanyWideStaffOnlyCaregiversAllPatientsAllCaregiverPatientVisitPatientCareTeamnull

audienceTargetId

string | nullrequiredmax length 64

The caregiver, patient or visit the alert is for, when the audience names one.

time

string · date-time | nullrequired

When the alert takes effect.

reviewDate

string · date-time | nullrequired

When the alert should be reviewed or cleared.

createdAt

string · date-time | nullrequiredread-only

When the alert was created.

updatedAt

string · date-time | nullrequiredread-only

When the alert was last changed.

next_cursor

string | null

Pass as cursor to fetch the next page. null on the last page.

has_more

boolean

Whether another page exists.

Response headers

Request-IdstringUnique ID of this request. Quote it when contacting support.

RateLimit-LimitintegerRequests allowed in the current window.

RateLimit-RemainingintegerRequests left in the current window.

RateLimit-ResetintegerSeconds until the window resets.

Errors

Status	Code	Meaning
400	n/a	The request was malformed, a value was invalid, or it contained an unknown field (`invalid_request`, `unknown_field`).
401	n/a	The API key is missing, malformed, expired or revoked (`unauthorized`).
403	n/a	The key is read-only (`insufficient_scope`), or its user's role cannot do this (`forbidden`).
429	n/a	Too many requests (`rate_limited`). Wait for `Retry-After` seconds.
500	n/a	Something went wrong on our side (`internal_error`). Retry, and quote the request ID if it persists.

Every error uses the same body. See Errors for the full list of codes.