Skip to main content
GET
Get Referral information

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Referral information

The link to share to prospects

Example:

"https://manage.mijnklantportaal.nl/register?referral=123abc"

timesUsed
integer

Users which have signed up via your link this period

Example:

6

usageLimit
integer

Maximum times your link can be used per period

Example:

12

usageReset
string | null

Date when the usages of your link will be reset. null when your link is not used (yet) this period.

Example:

"2027-08-28T00:00:00.000Z"