CTIX
Network live
CTIXGET

Get Users

Source docs
GEThttps://cs-testv2.cyware.com/ctixapi/rest-auth/users/

Returns the list of Intel Exchange users in a paginated format.

Query Parameters

NameTypeRequiredDescription
pageintegeroptional

Pass the page number to retrieve records.

page_sizeintegeroptional

Pass the number of records to retrieve on each page.

created_fromstringoptional

Pass the epoch time to filter users created after this timestamp.

created_tostringoptional

Pass the epoch time to filter users created before this timestamp.

is_activebooleanoptional

Pass true to include only active users in the response.

sortstringoptional

Pass the field to sort the user listing based on the field provided. The order can be reversed by prepending - before the key. For example, -created.

invited_bystringoptional

Pass the user ID to filter users who were invited by a specific user.

qstringoptional

Pass a search keyword to filter users by matching first_name, last_name, or email. The search is case-insensitive.

is_blockedbooleanoptional

Pass true to retrieve only blocked users. Pass false to retrieve only unblocked users.

invite_statusstringoptional

Pass the invite status to filter users based on whether they have accepted the invite.

activity_fromstringoptional

Pass the epoch timestamp to filter users who have been active after this point in time.

activity_tostringoptional

Pass the epoch timestamp to filter users who have been active before this point in time.

groupstringoptional

Pass the permission group ID to filter users belonging to a specific group.

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.

CTIXConnect to Intel ExchangeConnect to run

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.

Query Parameters
cURL
curl --request GET \
  --url "https://cs-testv2.cyware.com/ctixapi/rest-auth/users/?page=1&page_size=10&created_from=1622658600&created_to=1622744999&is_active=false&invited_by=9e2b0468-2a06-410e-bf3e-f5b29e17b077&q=cyw&is_blocked=false&invite_status=INVITED&activity_from=1624290146&activity_to=1624299145&group=139e4dc0-1eb6-443b-8809-f5b4417fee81&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.

JavaScript
const url = "https://cs-testv2.cyware.com/ctixapi/rest-auth/users/?page=1&page_size=10&created_from=1622658600&created_to=1622744999&is_active=false&invited_by=9e2b0468-2a06-410e-bf3e-f5b29e17b077&q=cyw&is_blocked=false&invite_status=INVITED&activity_from=1624290146&activity_to=1624299145&group=139e4dc0-1eb6-443b-8809-f5b4417fee81&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.

Python
import requests

url = "https://cs-testv2.cyware.com/ctixapi/rest-auth/users/"
params = {
    "page": "1",
    "page_size": "10",
    "created_from": "1622658600",
    "created_to": "1622744999",
    "is_active": "false",
    "invited_by": "9e2b0468-2a06-410e-bf3e-f5b29e17b077",
    "q": "cyw",
    "is_blocked": "false",
    "invite_status": "INVITED",
    "activity_from": "1624290146",
    "activity_to": "1624299145",
    "group": "139e4dc0-1eb6-443b-8809-f5b4417fee81",
    "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.

Example Response
{
  "next": "",
  "previous": "",
  "page_size": 10,
  "count": 1,
  "results": [
    {}
  ],
  "active_count": 1
}

View-only example — running live API calls requires a role with snippet testing access.