Skip to content

Reference

ledger.listParties

Paginated aggregation across GET /v2/parties until nextPageToken exhaustion — preferred naming versus legacy getParties.

Identical behavior to getParties: fetchAllParties loops Canton paging (pageSize 5000) concatenating partyDetails until nextPageToken empties.

Receiver: await canton.ledger.listParties

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Minimal example

const roster = await canton.ledger.listParties({});

Parameters — ListPartiesParams

Matches PartiesAggregationParams (optional pageToken).

Returns — ListPartiesResponse

Aggregated partyDetails arrays identical GetPartiesResponse bridging aggregator bridging fetchAllParties.

Errors and pitfalls

Same pagination safeguard throwing when tokens stagnate—watch Canton upgrades altering paging semantics.

Auth and party

Participant enumeration privileges identical getParties.

See also

Source

operations/v2/parties/list.ts