Referral Sources
Hospitals, physicians, case managers and other organizations that refer clients to your agency.
Endpoints
The ReferralSource object
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.