API Reference
  1. Viv Public API
  2. Referrers

List referrers

get
https://{apiHost}/api/v2/public/referrers

Retrieve a paginated list of individual referrer contacts.
Referrers are people (e.g., case managers, social workers) who belong to
referrer organizations and submit referrals.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

date-time

Return only records updated after this timestamp (ISO 8601)

string
enum

Filter by referrer status. Case-insensitive.

Allowed:
string

Filter by geographic location ID

string

Search referrers by name, email, or phone (case-insensitive partial match)

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?