Returns a list of keywords from the watchlist.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | string | optional | Pass the page number to retrieve watchlist keywords. |
| page_size | string | optional | Pass the number of keywords to retrieve on each page. |
| last_active_on_from | string | optional | Pass the last active from time in epoch format. |
| last_active_on_to | string | optional | Pass the last active to time in epoch format. |
| is_active | string | optional | Pass true to retrieve active keywords only. By default, both active and inactive keywords are retrieved. |
| created_from | string | optional | Pass the created from time in epoch format. |
| created_to | string | optional | Pass the created to time in epoch format. |
| created_by | string | optional | Pass the ID of a creator to filter keywords. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request GET \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/?page=1&page_size=10&last_active_on_from=1702252800&last_active_on_to=1703548799&is_active=true&created_from=1701648000&created_to=1703721599&created_by=bff67ec3-c591-4ab7-8677-f23671e2a65a&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E"View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/?page=1&page_size=10&last_active_on_from=1702252800&last_active_on_to=1703548799&is_active=true&created_from=1701648000&created_to=1703721599&created_by=bff67ec3-c591-4ab7-8677-f23671e2a65a&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "GET",
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/ingestion/watchlist/"
params = {
"page": "1",
"page_size": "10",
"last_active_on_from": "1702252800",
"last_active_on_to": "1703548799",
"is_active": "true",
"created_from": "1701648000",
"created_to": "1703721599",
"created_by": "bff67ec3-c591-4ab7-8677-f23671e2a65a",
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
response = requests.request("GET", url, params=params, headers=headers)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"next": "watchlist/?page=2&page_size=10&sort=-created",
"page_size": 10,
"previous": "",
"results": [
{}
],
"total": 219
}View-only example — running live API calls requires a role with snippet testing access.