---
title: "GET /v2/parties"
method: GET
path: "/v2/parties"
---

# GET /v2/parties

`GET /v2/parties`

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.

## Query parameters

- `identity-provider-id` string
- `filter-party` string
- `pageSize` integer
- `pageToken` string

## Response `200`

- ListKnownPartiesResponse
  - `partyDetails` PartyDetails[], required — The details of all Daml parties known by the participant. Required: must be non-empty
    - `party` string, required — The stable unique identifier of a Daml party. Must be a valid PartyIdString (as described in ``value.proto``). Required
    - `isLocal` boolean — true if party is hosted by the participant and the party shares the same identity provider as the user issuing the request. Optional
    - `localMetadata` ObjectMeta — Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party). Based on ``ObjectMeta`` meta used in Kubernetes API. See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640
      - `resourceVersion` string — An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional
      - `annotations` MapString
    - `identityProviderId` string — The id of the ``Identity Provider`` Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user's identity provider. Optional
  - `nextPageToken` string — Pagination token to retrieve the next page. Empty, if there are no further results. Optional

## Other responses

- `400` — Invalid value, Invalid value for: query parameter identity-provider-id, Invalid value for: query parameter filter-party, Invalid value for: query parameter pageSize, Invalid value for: query parameter pageToken
- `default`

---

[API](https://skmtc.dev/canton/apis/json-ledger-api-http-endpoints.md) · [All operations](https://skmtc.dev/canton/apis/json-ledger-api-http-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/canton/json-ledger-api-http-endpoints/revisions/296292e8b8f1/schema)