---
title: "List Holders"
method: GET
path: "/v1/organizations/{organization_id}/holders"
tags: ["Holders API"]
---

# List Holders

`GET /v1/organizations/{organization_id}/holders`

## Request

- Base URL: `https://identity.sandbox.lerian.net`
- URL: `https://identity.sandbox.lerian.net/v1/organizations/{organization_id}/holders`
- Auth: none required
- TypeScript: <https://skmtc.dev/lerian/apis/identity-plugin/docs/v1/organizations/:organization_id/holders/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `organization_id` string, uuid, required

## Query parameters

- `metadata` string: JSON string to filter holders by metadata fields
- `limit` string: Max items per page (1-100, default 10)
- `page` string: Page number (default 1)
- `sort_order` string: Sort direction (asc, desc)
- `include_deleted` string: Return includes logically deleted holders (true,false)
- `external_id` string: Filter holders by externalID
- `document` string: Filter holders by document

## Headers

- `X-Request-Id` string, uuid
- `Authorization` string

## Response `200`

OK

- Pagination
  - `items` unknown, required
  - `limit` integer, required
  - `next_cursor` string
  - `page` integer
  - `prev_cursor` string

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/lerian/apis/identity-plugin.md) - [All operations](https://skmtc.dev/lerian/apis/identity-plugin/llms.txt) - [OpenAPI document](https://skmtc.dev/lerian/apis/identity-plugin/revisions/25daba385532?raw)
