Skip to main content
GET
List referrals

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.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

user
string
user[]
string[]
referrer
string
referrer[]
string[]

Response

200 - application/json

Referral collection

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