latestOpenAPI 3.1.02026-08-1051108155.9 KB

6e6f8dad92bf

Referral

Returns paginated list of referrals for the sender

get/v1/referral

Query parameters

order'desc'

Direction to paginate through objects

limitinteger

Limit the number of objects to return

cursorstring

Pointer to the current object in pagination dataset

subaccountstring hex

Example:0x7072696d61727900000000000000000000000000000000000000000000000000

Bytes32 encoded subaccount name (0x prefix, zero padded, set when using linked signer)

orderBy'createdAt'

Example:createdAt

Order by field

Headers

X-Ethereal-Authstring required

Must be: EIP712Auth

X-Ethereal-Senderstring hex required

Address that signed this message

X-Ethereal-Signaturestring hex required

Hex-encoded EIP-712 signature authorizing this request

X-Ethereal-Intent0 | 1 | 2 | 3 required

Intent of the message (action to be taken)

X-Ethereal-SignedAtstring required

Message signedAt current timestamp (seconds since Unix Epoch)

Response

hasNextboolean required

Whether there are more objects to paginate through

nextCursorstring

Pointer to the next page in pagination dataset

Example response

{
  "data": [
    {
      "code": "XYZ123456789",
      "codeUsageRemaining": 5,
      "createdAt": 1712019600000,
      "id": "9036443a-441a-4a66-87f2-bd5c44cdca7a",
      "referee": "0x4c9EDD5852cd905f086C759E8383e09bff1E68B3",
      "refereeTotalPoints": "1234567.890000000",
      "referrer": "0x41e038d9c9aF27369EcBCe72A69a96695A1fD0D3"
    }
  ],
  "hasNext": true
}