Retrieve a list of created Label documents

PreviousCreate a new Label document for token (VP)NextRetrieve Label document by ID

Last updated 20 days ago

Was this helpful?

Return a list of all label documents.

Returns all label documents.

get

/policy-labels/{definitionId}/documents

Authorizations

Path parameters

definitionIdstringrequired

policy label Identifier

Example: 000000000000000000000001

Query parameters

pageIndexnumber

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumber

The numbers of items to return

Example: 20

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/policy-labels/{definitionId}/documents' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

[
  {
    "id": "000000000000000000000001",
    "definitionId": "000000000000000000000001",
    "policyId": "000000000000000000000001",
    "policyTopicId": "0.0.1",
    "policyInstanceTopicId": "0.0.1",
    "topicId": "0.0.1",
    "creator": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
    "owner": "#did:hedera:testnet:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_0.0.0000001",
    "messageId": "0000000000.000000001",
    "target": "0000000000.000000001",
    "document": {},
    "relationships": [
      "0000000000.000000001"
    ]
  }
]

Successful operation.