List referral sources
/v1/referral-sourcesReturns a page of referral sources. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return active (true) or inactive (false) sources.
Only return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
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.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The referral sources on this page.
Show item attributesHide item attributes(20)
String representing the object's type. Always referral_source.
Unique identifier of the referral source.
Name of the source.
Kind of source, such as Hospital or Physician.
Organization the contact works for.
Main contact.
Contact's job title.
Contact's phone number.
Contact's email address.
Street address.
City.
State, as a two-letter code.
ZIP code.
Notes.
Whether you still receive referrals from this source.
Referrals received from this source.
Referrals from this source that became clients.
When the most recent referral arrived.
When the referral source was created.
When the referral source was last changed.
Pass as cursor to fetch the next page. null on the last page.
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.