A valid request URL is required to generate request examples{
"codes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"owner_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"referred_count": 123,
"rate_basis_points": 123,
"fixed_amount_minor": 123,
"fixed_currency": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}List the referral codes of an environment
Requires billing:read. Every code this environment holds, with the contact it belongs to and how many people it has brought in. A code that has referred nobody is still a row — the list somebody is about to ask about is exactly the one a GROUP BY would hide.
A valid request URL is required to generate request examples{
"codes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"owner_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"referred_count": 123,
"rate_basis_points": 123,
"fixed_amount_minor": 123,
"fixed_currency": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de consulta
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Codes per page.
x <= 200Codes to skip.
Resposta
One page of codes.
Show child attributes
Show child attributes