List named lists
Retrieve all named lists for your organization including list metadata, status, and item counts.
Response Fields
Each named list in the response includes:
| Field | Type | Description |
|---|---|---|
id | UUID | Unique list identifier |
name | string | Human-readable list name |
type | string | List type (e.g., address_whitelist, approved_assets) |
description | string | List description |
status | string | ACTIVE or INACTIVE |
items | string[] | Array of list items |
organizationId | UUID | Owning organization ID |
itemCount | number | Number of items in the list |
createdAt | string | Creation timestamp (ISO 8601) |
updatedAt | string | Last update timestamp (ISO 8601) |
Status Values
| Status | Description |
|---|---|
ACTIVE | List is usable in policy conditions |
INACTIVE | List is disabled but not deleted |
Use Cases
- Build list management interfaces
- Browse available lists for policy configuration
- Audit list inventory and usage
- Display list summaries in dashboards
- Find lists by type or name
Required Permission
lists:read
List named lists
Retrieve all named lists for your organization including list metadata, status, and item counts.
Response Fields
Each named list in the response includes:
| Field | Type | Description |
|---|---|---|
id | UUID | Unique list identifier |
name | string | Human-readable list name |
type | string | List type (e.g., address_whitelist, approved_assets) |
description | string | List description |
status | string | ACTIVE or INACTIVE |
items | string[] | Array of list items |
organizationId | UUID | Owning organization ID |
itemCount | number | Number of items in the list |
createdAt | string | Creation timestamp (ISO 8601) |
updatedAt | string | Last update timestamp (ISO 8601) |
Status Values
| Status | Description |
|---|---|
ACTIVE | List is usable in policy conditions |
INACTIVE | List is disabled but not deleted |
Use Cases
- Build list management interfaces
- Browse available lists for policy configuration
- Audit list inventory and usage
- Display list summaries in dashboards
- Find lists by type or name
Required Permission
lists:read