List Watchlists
Watchlists
List Watchlists
Retrieve all watchlists for your tenant
GET
List Watchlists
Endpoint
Authentication
Requireswatchlist:list permission.
Query Parameters
Filter to show only active watchlists. Set to
true to exclude paused watchlists.Comma-separated list of tags to filter by. Returns watchlists that have any of the specified tags.Example:
tags=compliance,high-priorityRequest Examples
Get All Watchlists
Get Only Active Watchlists
Filter by Tags
Combine Filters
Response
Response Fields
| Field | Type | Description |
|---|---|---|
watchlists | array | List of watchlist objects |
count | integer | Total number of watchlists returned |
Watchlist Object Fields
| Field | Type | Description |
|---|---|---|
watchlist_id | string | Unique identifier |
name | string | Watchlist name |
status | string | active or paused |
tags | array | Custom tags for categorization |
last_checked_at | string/null | Last screening timestamp (ISO 8601) |
next_check_due | number/null | Next check timestamp (Unix milliseconds) |
check_frequency | string | Screening frequency |
Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 403 | Forbidden - Missing watchlist:list permission |
| 500 | Internal Server Error |