Skip to main content
GET
List referrers for a referral program
This endpoint is restricted and not generally available: organizations that have not been enabled receive a 403. Contact your Let’s Do This representative if you’d like access.

Authorizations

Authorization
string
header
required

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

Path Parameters

referralProgramId
string
required

The referral program id.

Query Parameters

page[size]
integer

How many results to return per page, from 1 to 500. Defaults to 100.

Required range: 1 <= x <= 500
page[after]
string

Pass page.next from the previous response to get the next page.

page[before]
string

Pass page.prev from the previous response to get the previous page.

Response

A page of referrers, one per referral code.

data
ReferralProgramReferrer · object[]
required
page
PageCursor · object
required

Where you are in a paginated list.

Pass next as page[after] to get the next page, or prev as page[before] to get the previous one. An empty cursor means there are no more pages in that direction. Treat cursors as opaque strings.

Example: