Skip to content
← Open Cap Table Protocol Canton Node SDK

Reference

ledger.getPartyDetails

GET /v2/parties/{party} — fetch metadata for one party with optional identity-provider + companion parties query hints.

Queries GET /v2/parties/{party} using GetPartyDetailsParams: party path segment plus optional identityProviderId plus repeated parties query multi-append semantics (parties arrays forwarded via URLSearchParams.append loops).

Receiver: await canton.ledger.getPartyDetails

Setup

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

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

Minimal example

const details = await canton.ledger.getPartyDetails({
  party: canton.getPartyId(),
});

Parameters — GetPartyDetailsParams

  • party (required string) — Target ledger party identifier.
  • identityProviderId (optional) — identity-provider-id query slot when Canton segregates provider namespaces.
  • parties (optional string[]) — Additional parties appended repeatedly per upstream Canton semantics.

Returns — paths['/v2/parties/{party}'].get JSON**

Structured PartyDetails shaped OpenAPI objects describing locality metadata (isLocal, annotations…).

Errors and pitfalls

Missing visibility (403/missing mapping) signals insufficient CanReadAs privileges versus referencing strangers outside managedParties.

Auth and party

OAuth bearer token—needs ledger identities revealing referenced party.

See also

Source

operations/v2/parties/get-party-details.ts