GET
/
users
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users?offset=20' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "users": [
{
    "id": "1234567890",
    "name": "John Doe",
    "language": "en",
    "occupation": "Salesman",
    "location": "London",
    "timezone": "Europe/London",
    "email": "john.doe@example.com",
    "isBanned": false,
    "role": {
    "alias": "learner"
},
    "fromApi": false,
    "image": null,
    "attributes": {}
}
    ],
    "totalCount": 1
}

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 email

Example: user@example.com

​
offset
integer

Entry number to start listing from

Example: 20

​
Response

​
users
array
required

Array of user objects

​
totalCount
integer
required

The total number of users

curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users?offset=20' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "users": [
{
    "id": "1234567890",
    "name": "John Doe",
    "language": "en",
    "occupation": "Salesman",
    "location": "London",
    "timezone": "Europe/London",
    "email": "john.doe@example.com",
    "isBanned": false,
    "role": {
    "alias": "learner"
},
    "fromApi": false,
    "image": null,
    "attributes": {}
}
    ],
    "totalCount": 1
}