API ReferenceRetrieving Referrals

List referrals

Path parameters

institutionIdTypeenumRequired
The type of institution ID
Allowed values:
institutionIdstringRequired
The institution ID

Query parameters

offsetdoubleOptionalDefaults to 0
Offset for pagination
pageSizedoubleOptional<=1000Defaults to 10
Number of items per page
statuslist of enumsOptional
roleenumOptional
To filter by the institution's role in the referral. e.g. For outbound referrals, use "sender'
Allowed values:
referrerIdstringOptional
To filter by the referrer ID
referrerIdTypeenumOptional

Type of ID specified in referrerId. Use together with referrerId to filter based on referrer.

Allowed values:
patientUinstringOptional
To filter by the patient UIN

Response

datalist of objects
metadataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error