Skip to navigation
API ReferenceRetrieving Referrals

Get a referral action link by type

Path parameters

referralIdstringRequired
The ID of the referral
typeenumRequired
The type of action link to retrieve
Allowed values:

Request

This endpoint expects an object.
requesterIdentifierstringRequired
Identifier for the individual requesting the referral. Preferred to be an email.
institutionIdTypeenumRequired
The type of institution ID
Allowed values:
institutionIdstringRequired
The institution ID
attachmentIdstringOptional

ID of the attachment. Required when the action link type is attachment.

Response

typeenum
type of referral action
Allowed values:
labelstring

Human-readable label that can be displayed directly to users

urlstring
The URL of the link
attachmentobjectOptional

Errors

401
Unauthorized Error