Skip to main content
GET
/
users
/
{userId}
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": "1234567890",
    "name": "John Doe",
    "language": "en",
    "occupation": "Salesman",
    "location": "London",
    "timezone": "Europe/London",
    "email": "[email protected]",
    "isBanned": false,
    "role": {
        "alias": "learner"
    },
    "fromApi": false,
    "image": null,
    "attributes": {}
}
Retrieve detailed information about a specific user using their unique ID.

​
Request Headers

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

​
URL Parameters

​
userId
string
required
User API ID (alphanumeric unique identifier)

​
Response

​
id
string
required
User ID, alphanumeric unique identifier
​
name
string
required
Full name of the user
​
language
string
required
Interface language (de, en, es, fr, pl, pt, ru)
​
occupation
string
Job title
​
location
string
Location
​
timezone
string
required
Timezone in TZ format
​
email
string
required
Email address
​
isBanned
boolean
required
Whether user is banned from login
​
role
string
required
User role alias/identifier
​
fromApi
boolean
required
Whether user is managed via API only
​
image
object
User avatar
​
attributes
object
Custom user attributes

​
Error Responses

​
404
object
Returned when user is not found
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": "1234567890",
    "name": "John Doe",
    "language": "en",
    "occupation": "Salesman",
    "location": "London",
    "timezone": "Europe/London",
    "email": "[email protected]",
    "isBanned": false,
    "role": {
        "alias": "learner"
    },
    "fromApi": false,
    "image": null,
    "attributes": {}
}