Skip to main content
Version: pre-release (v0.79)

List teams

GET 

/api/v2/teams

Get a list of all teams, or for a specific team by using team ID, or party ID of a referrer or referee

Request

Query Parameters

    teamId string

    Restrict teams to those with the given team ID.

    partyId string

    Restrict teams to those where the given party is a referrer or a referee.

    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.

Responses

A successful response.

Schema
    teams object

    Page of team data and corresponding page information.

    edges object[]

    Page of team data and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Team data.

    allowList string[]

    List of public keys that are allowed to join the team. Only applicable to closed teams.

    avatarUrl string

    Link to an image of the team's avatar.

    closed boolean

    Whether or not the team is closed to new party members. When closed, only parties specified in the allow list can join the team.

    createdAt int64

    Timestamp in Unix nanoseconds when the team was created.

    createdAtEpoch uint64

    Epoch at which the team was created.

    name string

    Name of the team.

    referrer string

    Party ID that created the team.

    teamId string

    ID of the created team.

    teamUrl string

    Link to the team's homepage.

    totalMembers uint64

    Current number of members in the team.

  • ]
  • 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...