Skip to main content
GET
Error

Authorizations

x-cdata-authtoken
string
header
required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Query Parameters

$filter
string

OData-style filter expression applied to the collection, on endpoints that support filtering (e.g. name eq 'my_job'). Filters on resource fields such as id and name. Substring matching with contains(name,'my_job') is case-insensitive. startswith and endswith retain their existing behavior; case sensitivity depends on the AppDB collation.

$orderby
string

OData-style sort expression applied to the collection, on endpoints that support sorting (e.g. name asc, created_at desc).

$top
integer

Maximum number of records to return (pagination), where supported.

$skip
integer

Number of records to skip before returning results (pagination), where supported.

Response

One or more users

id
string
user
string

Username.

email_address
string
is_active
boolean
roles
object[]
sso_enabled
boolean
mfa_enabled
boolean
api_enabled
boolean
auth_token_created_at
string<date-time>
auth_token_expires_in
integer

Seconds until token expiry.

created_at
string<date-time>
updated_at
string<date-time>