AveeCare

Retrieve a referral source

get/v1/referral-sources/{id}

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

Response

200

The referral source.

object
stringread-only

String representing the object's type. Always referral_source.

id
stringread-only

Unique identifier of the referral source.

name
string | nullmax length 200

Name of the source.

type
string | nullmax length 100

Kind of source, such as Hospital or Physician.

organization
string | nullmax length 200

Organization the contact works for.

contactName
string | nullmax length 200

Main contact.

contactTitle
string | nullmax length 100

Contact's job title.

contactPhone
string | nullmax length 30

Contact's phone number.

contactEmail
string · email | nullmax length 320

Contact's email address.

address
string | nullmax length 200

Street address.

city
string | nullmax length 100

City.

state
string | nullmax length 50

State, as a two-letter code.

zipCode
string | nullmax length 20

ZIP code.

notes
string | nullmax length 20000

Notes.

isActive
boolean | null

Whether you still receive referrals from this source.

totalReferrals
integer | nullread-only

Referrals received from this source.

totalConversions
integer | nullread-only

Referrals from this source that became clients.

lastReferralDate
string · date-time | nullread-only

When the most recent referral arrived.

createdAt
string · date-time | nullread-only

When the referral source was created.

updatedAt
string · date-time | nullread-only

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