Skip to main content
GET
List referrals for a referrer
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.

referralCodeOwnerBookingId
string
required

The booking that owns the generated referral code.

Query Parameters

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

Response

Default Response

A standard cursor-paginated list of entries attributed to a referrer.

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

Cursor details for pagination.

  • In scenarios with large amounts of data, it's common to return only a subset of data in a single request, known as a "page".
  • Most API responses include two objects: a 'data' object with the query results, and a 'PageCursor' object detailing the current page.
  • Cursors can be used to navigate to earlier or later pages in the set of results. For instance, passing the 'next' cursor from 'PageCursor' fetches the next set of results.
  • Cursors are base64 encoded strings.
Example: