Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.topology.admin.v30ServicesTopologyAggregationServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.topology.admin.v30ServicesTopologyAggregationService

ListParties

Shared Administration›Protobuf›com.digitalasset.canton.topology.admin.v30›ListParties

com.digitalasset.canton.topology.admin.v30

​
ListParties

gRPCSince 3.4.0
RPC/com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties

​
Protocol Details

​
Inputs

​
ListPartiesRequest

as_ofTimestamp
limitint32
synchronizer_idsrepeated string
filter_partystring
filter_participantstring

​
Outputs

​
ListPartiesResponse

resultsrepeated Result

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.topology.admin.v30.ListPartiesRequest

as_ofTimestamp
limitint32
synchronizer_idsrepeated string
filter_partystring
filter_participantstring

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse

resultsrepeated Result

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result

partystring
participantsrepeated ParticipantSynchronizers

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers

participant_uidstring
synchronizersrepeated SynchronizerPermissions

com.digitalasset.canton.topology.admin.v30.ListPartiesResponse.Result.ParticipantSynchronizers.SynchronizerPermissions

synchronizer_idstring
permissionParticipantPermission
physical_synchronizer_idstring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.topology.admin.v30.TopologyAggregationService/ListParties <<'EOF'
{
  "asOf": "string",
  "limit": 0,
  "synchronizerIds": [
    "string"
  ],
  "filterParty": "string",
  "filterParticipant": "string"
}
EOF
OKapplication/json
OK
{
  "results": [
    {
      "party": "string",
      "participants": [
        {
          "participantUid": "string",
          "synchronizers": [
            {
              "synchronizerId": "string",
              "permission": "string",
              "physicalSynchronizerId": "string"
            }
          ]
        }
      ]
    }
  ]
}