Skip to content

Reference

ledger.listUsers

GET /v2/users — paginated user listing via pageSize and pageToken query params.

Calls GET /v2/users exposing pageSize, pageToken (operations/v2/users/list-users.ts).

Receiver: await canton.ledger.listUsers

Setup

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

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

Minimal example

const page = await canton.ledger.listUsers({ pageSize: 50 });

Parameters — ListUsersParams

Optional pageSize, pageToken.

Returns — ListUsersResponse

Paged users arrays plus nextPageToken per Canton semantics.

Auth and party

Admin-scope bearer enumerating identities Canton exposes participant-wide.

Source

operations/v2/users/list-users.ts