Get named list by ID
Retrieve a specific named list with complete details including all items. Use this endpoint when you need the full list contents.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | Named list identifier |
Response Fields
| Field | Type | Description |
|---|---|---|
id | UUID | Unique list identifier |
name | string | Human-readable list name |
type | string | List type identifier |
description | string | List description |
status | string | ACTIVE or INACTIVE |
items | string[] | Complete array of all list items |
metadata | object | Additional key-value metadata |
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) |
Use Cases
- Display complete list contents in detail views
- Export list items for backup or analysis
- Verify list configuration before policy use
- Review all addresses in a whitelist/blacklist
- Audit list membership
Required Permission
lists:read
Get named list by ID
Retrieve a specific named list with complete details including all items. Use this endpoint when you need the full list contents.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | Named list identifier |
Response Fields
| Field | Type | Description |
|---|---|---|
id | UUID | Unique list identifier |
name | string | Human-readable list name |
type | string | List type identifier |
description | string | List description |
status | string | ACTIVE or INACTIVE |
items | string[] | Complete array of all list items |
metadata | object | Additional key-value metadata |
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) |
Use Cases
- Display complete list contents in detail views
- Export list items for backup or analysis
- Verify list configuration before policy use
- Review all addresses in a whitelist/blacklist
- Audit list membership
Required Permission
lists:read