Skip to main content
GET

JSON Ledger API

List the parties known by the participant

OpenAPISince 3.4Changed 3.5
List the parties known by the participant. The list returned contains parties whose ledger access is facilitated by the participant and the ones maintained elsewhere.

Protocol Details

Operation IDgetV2Parties
AuthenticationBearer token
Published3.5

Inputs

Query parameters

string
string
number
OpenAPI type: integer (int32).maximum number of elements in a returned page
string
token - to continue results from a given page, leave empty to start from the beginning of the list, obtain token from the result of previous page

Outputs

200

application/json
PartyDetails[]
required
The details of all Daml parties known by the participant. Required: must be non-empty
string
Pagination token to retrieve the next page. Empty, if there are no further results. Optional

400

text/plain
string
required

default

application/json
string
required
string
required
string
string
Map_String
required
Tuple2_String_String[]
integer (int32)
required
integer (int32)
string
boolean

History

Changed3.5

The GET /v2/parties operation changed in this snapshot.

Introduced3.4