List referrals

get/v1/referrals

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

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.

status

string

Only return referrals with this status.

One ofNewContactedAssessmentScheduledAssessmentCompletedServiceAgreementSentAdmittedDeclinedLost

referral_source_id

string

Only return referrals from this source.

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

Show item attributesHide item attributes(17)

object

stringrequiredread-only

String representing the object's type. Always referral.

stringrequiredread-only

Unique identifier of the referral.

referralSourceId

string | nullrequiredmax length 64

Who made the referral.

patientId

string | nullrequiredmax length 64

The patient record, once one exists.

patientName

string | nullrequiredmax length 200

Name of the person referred.

contactPhone

string | nullrequiredmax length 30

Phone number to reach the person or their family.

contactEmail

string · email | nullrequiredmax length 320

Email address to reach the person or their family.

referralDate

string · date-time | nullrequired

When the referral arrived.

status

string | nullrequired

Where the referral stands.

One ofNewContactedAssessmentScheduledAssessmentCompletedServiceAgreementSentAdmittedDeclinedLostnull

estimatedCareNeeds

string | nullrequiredmax length 20000

Care the person is expected to need.

estimatedWeeklyHours

number | nullrequiredmin 0

Expected hours of care per week.

urgencyLevel

string | nullrequiredmax length 50

How soon care is needed.

declineReason

string | nullrequiredmax length 20000

Why the referral was declined or lost.

notes

string | nullrequiredmax length 20000

Notes.

convertedDate

string · date-time | nullrequiredread-only

When the person was admitted as a client.

createdAt

string · date-time | nullrequiredread-only

When the referral was created.

updatedAt

string · date-time | nullrequiredread-only

When the referral 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.