AveeCare

Retrieve a referral

get/v1/referrals/{id}

Returns one referral by ID. 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

Path parameters

id
stringrequired

ID of the referral.

Response

200

The referral.

object
stringread-only

String representing the object's type. Always referral.

id
stringread-only

Unique identifier of the referral.

referralSourceId
string | nullmax length 64

Who made the referral.

patientId
string | nullmax length 64

The patient record, once one exists.

patientName
string | nullmax length 200

Name of the person referred.

contactPhone
string | nullmax length 30

Phone number to reach the person or their family.

contactEmail
string · email | nullmax length 320

Email address to reach the person or their family.

referralDate
string · date-time | null

When the referral arrived.

status
string | null

Where the referral stands.

One ofNewContactedAssessmentScheduledAssessmentCompletedServiceAgreementSentAdmittedDeclinedLostnull
estimatedCareNeeds
string | nullmax length 20000

Care the person is expected to need.

estimatedWeeklyHours
number | nullmin 0

Expected hours of care per week.

urgencyLevel
string | nullmax length 50

How soon care is needed.

declineReason
string | nullmax length 20000

Why the referral was declined or lost.

notes
string | nullmax length 20000

Notes.

convertedDate
string · date-time | nullread-only

When the person was admitted as a client.

createdAt
string · date-time | nullread-only

When the referral was created.

updatedAt
string · date-time | nullread-only

When the referral was last changed.

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
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).
404
n/a
No such object, or it is not visible to this key (not_found).
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.