Returns referral status counts
Returns aggregate counts for the referrals visible to your group, so you
can build dashboards or reconcile totals without paging through
GET /api/v2/referrals. No extra permission is required.
total_referralsis the number of matching referrals.referral_status_countscounts referrals by the top-level (case and billing)status. Every status is present, with0when no referral has it. The values add up tototal_referrals.visit_status_countscounts distinct referrals that have at least one visit in eachvisits[].status. Every status is present, with0when no referral has it. A referral with visits in two statuses is counted under both, and a referral with no visits is counted under none, so these values can add up to more or less thantotal_referrals.
Accepts the same billable, created_date, date_of_service, and
invoice_date filters as the referral list.
Authorizations
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
Date of referral creation
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.
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.
When true, also include referrals whose billing-company name matches the authenticated group
Response
referral status counts
Number of referrals that match the filters
Referrals per top-level status. Every status is present, with 0 for statuses that have no referrals. Values add up to total_referrals.
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.

