Skip to main content
GET
Retrieve a partner referral request

Autorisaties

Authorization
string
header
vereist

An Account API key or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

partner:referral_request:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

Partner referral request ID, prefixed prfr_.

Respons

Request retrieved.

account
object | null
vereist

Business receiving the request, when one is assigned.

authorized_user_id
string | null
vereist

The partner's team membership this referral was created for, prefixed ausr_. null when the referral is personal.

Voorbeeld:

null

code
string | null
vereist

Unique referral code, when assigned.

Voorbeeld:

null

created_at
string
vereist

When the request was created, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

id
string
vereist

Partner referral request ID, prefixed prfr_.

Voorbeeld:

"prfr_xxxxxxxxxxxxxx"

max_redemptions
integer | null
vereist

Maximum permitted redemptions, when limited.

Voorbeeld:

null

member_id
string | null
vereist

The partner's member record this referral was created for, prefixed mber_, when their role on that business is held on their member record. null otherwise.

Voorbeeld:

null

partner
object
vereist

Public profile of the requesting partner.

referring_account
object | null
vereist

Business the partner sent this request on behalf of, when the referral belongs to their team. null for a personal referral.

request_type
enum<string>
vereist

How the referral request was initiated.

Beschikbare opties:
manual,
ownership_transfer,
link
Voorbeeld:

"manual"

rewards
object[]
vereist
status
enum<string> | null
vereist

The approval state, or null for requests without an approval process.

Beschikbare opties:
pending,
accepted,
denied,
cancelled,
null
Voorbeeld:

"accepted"

updated_at
string
vereist

When the request last changed, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

user
object | null
vereist
verouderd

The user an attribution request was sent to. Deprecated: requests to a user have ended. Always null. DEPRECATED: No longer populated. Always null.