Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Referrals

Get referral

Get the redemption code and expiry for a referral.

get/v1/applications/{applicationId}/referrals/{referralId}

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
referralIdstring required
Example:referral_tz4a98xxat96iws9zmbrgj3a

Response

Success

_idstring required

The unique ID of the referral.

codestring required

A referral code using the format AK_ followed by 10 uppercase alphanumeric characters.

referencestring required

The default reference that applications created from this referral will use.

expires_atstring date-time required

The time after which the referral code can no longer be redeemed.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "_id": "referral_tz4a98xxat96iws9zmbrgj3a",
  "code": "AK_23456789BC"
}