This API endpoint retrieves a list of global notes.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | string | optional | Pass the page number to retrieve the notes in a threat data object. |
| page_size | string | optional | Pass the number of notes to retrieve on each page. |
| object_id | string | optional | Pass the ID of a threat data object to retrieve the associated notes. |
| created_by | string | optional | Pass the ID of a user to retrieve the associated notes. |
| created_from | string | optional | Pass the start date of the notes created state in epoch format to filter notes. |
| created_to | string | optional | Pass the end date of the notes created date in epoch format to filter notes. |
| q | string | optional | Pass the query text to search in notes. |
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/notes/?page=1&page_size=10&object_id=c611c22c-8175-41e8-ae51-aee29c7b1c29&created_by=58a66a94-fe9b-4928-ba44-d38fda6f06f3&created_from=1685607229&created_to=1685607261&q=sha&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/notes/?page=1&page_size=10&object_id=c611c22c-8175-41e8-ae51-aee29c7b1c29&created_by=58a66a94-fe9b-4928-ba44-d38fda6f06f3&created_from=1685607229&created_to=1685607261&q=sha&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/notes/"
params = {
"page": "1",
"page_size": "10",
"object_id": "c611c22c-8175-41e8-ae51-aee29c7b1c29",
"created_by": "58a66a94-fe9b-4928-ba44-d38fda6f06f3",
"created_from": "1685607229",
"created_to": "1685607261",
"q": "sha",
"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": {},
"page_size": 10,
"previous": {},
"results": [
{}
],
"total": 2
}View-only example — running live API calls requires a role with snippet testing access.