Skip to main content
GET
Returns referral status counts

Authorizations

Authorization
string
header
required

Authorization: Bearer <api_token>. Reuse the same token on later requests until it expires or is revoked. Do not request a new token for each call. The token does not expire after 24 hours. Sandbox tokens come from Get API keys and allow 2,000 successful requests or 7 days, or 90 days with an access code. Failed 4xx/5xx responses do not consume the allowance. Production tokens are issued from the group's API access tab and last until the expiry set there, or until revoked when no expiry is set.

Query Parameters

created_date
string

Date of referral creation

date_of_service

Filter by visit start time. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit start falls in the window. Unscheduled visits are excluded.

invoice_date

Filter by when a visit became invoice ready. Pass one date (YYYY-MM-DD) for that Eastern day, or two dates for an inclusive range. A referral matches if any visit moved to invoice_ready in the window.

billable
boolean

When true, also include referrals whose billing-company name matches the authenticated group

Response

referral status counts

total_referrals
integer

Number of referrals that match the filters

referral_status_counts
object

Referrals per top-level status. Every status is present, with 0 for statuses that have no referrals. Values add up to total_referrals.

visit_status_counts
object

Distinct referrals with at least one visit in each visits[].status. Every status is present, with 0 for statuses that have no referrals. Values can add up to more or less than total_referrals.