Referral Source Type

Types of referrals for patients

ReferralSourceType

created_at	string <date-time>
id	string <int64>
	object
name	string <= 255 characters
referrer_type	string or null Enum: "Contact" "Patient"
	object or null
subcategories	Array of strings or null
updated_at	string <date-time>

{"created_at": "2019-08-24T14:15:22Z",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/referral_source_types/1"
},
"name": "string",
"referrer_type": "Contact",
"referrers": {"links": {"self": "https://api.au1.cliniko.com/v1/patients"
}
},
"subcategories": ["the google",
"myspace",
"friendster",
"ask jeeves"
],
"updated_at": "2019-08-24T14:15:22Z"
}

List referral source types

get/referral_source_types

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
id	int64
created_at	date-time
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"referral_source_types": [{"created_at": "2019-08-24T14:15:22Z",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/referral_source_types/1"
},
"name": "string",
"referrer_type": "Contact",
"referrers": {"links": {"self": "https://api.au1.cliniko.com/v1/patients"
}
},
"subcategories": ["the google",
"myspace",
"friendster",
"ask jeeves"
],
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/referral_source_types?page=2",
"previous": "https://api.au1.cliniko.com/v1/referral_source_types?page=1",
"next": "https://api.au1.cliniko.com/v1/referral_source_types?page=3"
}
}

Get referral source type

get/referral_source_types/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"created_at": "2019-08-24T14:15:22Z",
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/referral_source_types/1"
},
"name": "string",
"referrer_type": "Contact",
"referrers": {"links": {"self": "https://api.au1.cliniko.com/v1/patients"
}
},
"subcategories": ["the google",
"myspace",
"friendster",
"ask jeeves"
],
"updated_at": "2019-08-24T14:15:22Z"
}