Skip to main content
Version: release (v0.77)

List referral sets

GET 

/api/v2/referral-sets

List all referral sets, or a specific referral set if you know its ID.

Request

Query Parameters

    referralSetId string

    Referral set ID to retrieve information for.

    pagination.first int32

    Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

    pagination.after string

    If paging forwards, the cursor string for the last row of the previous page.

    pagination.last int32

    Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

    pagination.before string

    If paging forwards, the cursor string for the first row of the previous page.

    pagination.newestFirst boolean

    Whether to order the results with the newest records first. If not set, the default value is true.

    referrer string

    Referrer to filter by. If referrer set ID is provided, this field is ignored.

    referee string

    Referee to filter by. If referrer set ID or referrer is provided, this field is ignored.

Responses

A successful response.

Schema
    referralSets object

    Page of referral set data and corresponding page information.

    edges object[]

    Page of referral set data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Referral set data.

    createdAt int64

    Timestamp, in Unix nanoseconds, when the set was created.

    id string

    Unique ID of the created set.

    referrer string

    Party that created the set.

    totalMembers uint64

    Current number of members in the referral set.

    updatedAt int64

    Timestamp, in Unix nanoseconds, when the set was updated.

  • ]
  • pageInfo object

    Page information that is used for fetching further pages.

    endCursor string

    End cursor.

    hasNextPage boolean

    Indicator if there is a next page.

    hasPreviousPage boolean

    Indicator if there is a previous page.

    startCursor string

    Start cursor.

Loading...