Skip to main content
GET
Retrieve a paginated list of users from your platform. The list is sorted by name and includes 20 entries per page.

Request Headers

X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

Query Parameters

query
string
Get user info by emailExample: user@example.com
offset
integer
Entry number to start listing fromExample: 20

Response

users
array
required
Array of user objects
totalCount
integer
required
The total number of users