GET
/
users
/
byEmail
/
{userEmail}
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/byEmail/user@example.com' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
    "id": "1234567890",
    "name": "John Doe",
    "language": "en",
    "occupation": "Salesman",
    "location": "London",
    "timezone": "Europe/London",
    "email": "user@example.com",
    "isBanned": false,
    "role": {
    "alias": "learner"
},
    "fromApi": false,
    "image": null,
    "attributes": {}
}
Retrieve detailed information about a specific user using their email address.

Request Headers

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

URL Parameters

userEmail
string
required
Email address of the user to retrieve

Response

id
string
required
User ID
name
string
required
Full name
language
string
required
Interface language (de, en, es, fr, pl, pt, ru)
occupation
string
Job title
location
string
Location
timezone
string
required
Timezone
email
string
required
Email address
isBanned
boolean
required
Ban status
role
string
required
User role
fromApi
boolean
required
API management status
image
object
User avatar
attributes
object
Custom attributes

Error Responses

400
object
Returned for validation errors
404
object
Returned when user is not found
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/byEmail/user@example.com' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
    "id": "1234567890",
    "name": "John Doe",
    "language": "en",
    "occupation": "Salesman",
    "location": "London",
    "timezone": "Europe/London",
    "email": "user@example.com",
    "isBanned": false,
    "role": {
    "alias": "learner"
},
    "fromApi": false,
    "image": null,
    "attributes": {}
}