AveeCare

List contacts

get/v1/contacts

Returns a page of contacts. Filters combine with AND. Use next_cursor to fetch the next page.

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.

patient_id
string

Only return contacts of this patient.

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 contacts on this page.

Show item attributesHide item attributes(12)
object
stringrequiredread-only

String representing the object's type. Always contact.

id
stringrequiredread-only

Unique identifier of the contact.

patientId
string | nullrequiredmax length 64

The patient this contact belongs to.

name
string | nullrequiredmax length 200

Full name.

relationship
string | nullrequiredmax length 100

Relationship to the patient.

phoneNumber
string | nullrequiredmax length 30

Phone number.

email
string · email | nullrequiredmax length 320

Email address.

preferEmail
boolean | nullrequired

Whether the contact prefers email over phone.

emergencyContact
boolean | nullrequired

Whether this person is an emergency contact.

notificationPolicy
string | nullrequired

Which updates the contact is notified about.

One ofAllEmergenciesnull
createdAt
string · date-time | nullrequiredread-only

When the contact was created.

updatedAt
string · date-time | nullrequiredread-only

When the contact 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

StatusCodeMeaning
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.