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

List parties

GET 

/api/v2/parties

Get a list of parties

Request

Query Parameters

    partyId string

    Restrict the returned party to only the given party ID. If not set, all parties will be returned.

    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
    parties object

    Page of parties data and corresponding page information.

    edges object[]

    Page of parties and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Data associated with a party.

    alias string

    Alias given to the party.

    id string

    Unique ID for the party, typically represented by a public key.

    metadata object[]

    Metadata to associate to a party, in a key/value format where the key describes the type of metadata in the value field.

  • Array [
  • key string

    Key of the metadata.

    value string

    Value of the metadata.

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