Returns a list of custom attributes from the platform.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| sort | string | optional | Pass |
| page_size | integer | optional | Pass the number of records to retrieve on each page. |
| page | integer | optional | Pass the page number to retrieve records. |
| ctix_created_from | string | optional | Pass the |
| ctix_created_to | string | optional | Pass the |
| type | integer | optional | Pass a number for the respective attribute type. |
| status | integer | optional | Pass a number for the respective status. |
| manual | boolean | optional | Pass true to retrieve custom attributes manually created by users. Pass false to retrieve custom attributes created by the system. |
| q | string | optional | Pass a keyword to search for attributes by the title. |
| ctix_modified_from | string | optional | Pass the |
| ctix_modified_to | string | optional | Pass the |
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/configuration/custom-attribute/?sort=ctix_modified&page_size=5&page=1&ctix_created_from=1633090980&ctix_created_to=1633090981&type=3&status=1&manual=true&q=pin&ctix_modified_from=1711929600&ctix_modified_to=1712620799&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/configuration/custom-attribute/?sort=ctix_modified&page_size=5&page=1&ctix_created_from=1633090980&ctix_created_to=1633090981&type=3&status=1&manual=true&q=pin&ctix_modified_from=1711929600&ctix_modified_to=1712620799&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/configuration/custom-attribute/"
params = {
"sort": "ctix_modified",
"page_size": "5",
"page": "1",
"ctix_created_from": "1633090980",
"ctix_created_to": "1633090981",
"type": "3",
"status": "1",
"manual": "true",
"q": "pin",
"ctix_modified_from": "1711929600",
"ctix_modified_to": "1712620799",
"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": {},
"previous": {},
"total": 1,
"results": [
{}
],
"page_size": 5
}View-only example — running live API calls requires a role with snippet testing access.