> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/develop/developer-tools-and-resources/logging-configuration/policy-repository-apis.md).

# Policy Repository APIs

Base URL: `/api/v1/policy-labels`

These endpoints provide read access to user lists, schema lists, and document lists within a specific policy instance. Primarily used by administrators and external tools inspecting policy state.

***

## GET /policy-labels/:policyId/users

Returns the list of usernames that have participated in (or registered with) the specified policy.

**Authentication:** Required (Bearer JWT)\
**Permission:** `POLICIES_POLICY_READ`

### Path Parameters

| Parameter | Type   | Required | Description                            |
| --------- | ------ | -------- | -------------------------------------- |
| policyId  | string | Yes      | Policy MongoDB ObjectId (24 hex chars) |

### Responses

| Code | Description           |
| ---- | --------------------- |
| 200  | Array of usernames    |
| 401  | Unauthorized          |
| 403  | Forbidden             |
| 404  | Policy not found      |
| 500  | Internal server error |

### Example

**Request:**

```http
GET /api/v1/policy-labels/63e3e5e8a01b3c001234abcd/users
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...
```

**Response 200:**

```json
["alice", "bob", "installer_1", "installer_2"]
```

***

## GET /policy-labels/:policyId/schemas

Returns the list of schemas used within the specified policy.

**Authentication:** Required (Bearer JWT)\
**Permission:** `POLICIES_POLICY_READ`

### Path Parameters

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| policyId  | string | Yes      | Policy MongoDB ObjectId |

### Responses

| Code | Description                     |
| ---- | ------------------------------- |
| 200  | Array of schema summary objects |
| 401  | Unauthorized                    |
| 403  | Forbidden                       |
| 404  | Policy not found                |
| 500  | Internal server error           |

### Example

**Request:**

```http
GET /api/v1/policy-labels/63e3e5e8a01b3c001234abcd/schemas
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...
```

**Response 200:**

```json
[
  {
    "id": "63f1a2b3c4d5e6f789012345",
    "name": "MRV Schema",
    "entity": "MRV",
    "version": "1.0.0",
    "iri": "did:hedera:testnet:zSchemaIRI...",
    "topicId": "0.0.4532002"
  }
]
```

***

## GET /policy-labels/:policyId/documents

Returns the list of VC documents submitted within the specified policy.

**Authentication:** Required (Bearer JWT)\
**Permission:** `POLICIES_POLICY_READ`

### Path Parameters

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| policyId  | string | Yes      | Policy MongoDB ObjectId |

### Query Parameters

| Parameter | Type   | Required | Description                               |
| --------- | ------ | -------- | ----------------------------------------- |
| pageIndex | number | No       | Zero-based page number                    |
| pageSize  | number | No       | Items per page                            |
| type      | string | No       | Filter by document type (e.g. `VC`, `VP`) |
| owner     | string | No       | Filter by owner DID                       |

### Responses

| Code | Description                                                        |
| ---- | ------------------------------------------------------------------ |
| 200  | Array of document summaries. Total count in `X-Total-Count` header |
| 401  | Unauthorized                                                       |
| 403  | Forbidden                                                          |
| 404  | Policy not found                                                   |
| 500  | Internal server error                                              |

### Example

**Request:**

```http
GET /api/v1/policy-labels/63e3e5e8a01b3c001234abcd/documents?pageIndex=0&pageSize=20&type=VC
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...
```

**Response 200:**

```
X-Total-Count: 87
```

```json
[
  {
    "id": "63e3e5e8a01b3c00aabbccdd",
    "type": "VC",
    "schema": "MRVDocument",
    "owner": "did:hedera:testnet:zHcDLGFNymFAJiMBKnpbHDgjvTn6yZnwkPPeFhtJBECH_0.0.4532001",
    "status": "APPROVED",
    "createDate": "2026-03-30T08:00:00.000Z"
  }
]
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://guardian.hedera.com/docs/develop/developer-tools-and-resources/logging-configuration/policy-repository-apis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.