Skip to main content
GET
Get a referral

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

hash
string
required

Referral identifier

Response

Referral resource

hash
string
id
integer
read-only
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

user
object
dateCreated
string<date-time>
read-only
status
string
default:AWAITING_REFERRAL
dateCompleted
string<date-time> | null