Skip to content

Get referral code

GET
/referral-codes/{referralCodeId}

Get a referral code by id

Authorizations

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-01"
Pattern
"^\\d{4}-\\d{2}-\\d{2}$"

Path Parameters

referralCodeId*
Type
string
Required

Responses

success.referral.get

application/json
object
object
Required

Playground

Authorization
Headers
Variables
Key
Value

Samples