Skip to main content

Get a User

Retrieve a single user by their user id or email address.

GET
/api/public/users/{user_id_or_email}

Headers​

KeyValue
AuthorizationBearer <Account API Key>

Path Parameter​

  • user_id_or_email (required): The numeric user id, or the email address of the user.

Query parameters​

ParameterTypeDescription
stats (optional)Booleantrue to populate the stats object. Applies when looking up by user id.
nonce (optional)StringSingle sign-on nonce issued to a container app. When supplied it is validated against the requested user; an invalid nonce returns 403.

Example cURL​

By user id:

curl --location '<BUILDER_URL>/api/public/users/83?stats=true' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX'

By email:

curl --location '<BUILDER_URL>/api/public/users/jane@example.com' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXX'

Responses​

Status CodeDescriptionResponse
200Success. Returns the user object.application/json
400The path value is neither a numeric id nor a valid email addressapplication/json
401Unauthorizedapplication/json
403Invalid nonceapplication/json
404User not found in this accountapplication/json
500Internal Server Errorapplication/json

Sample response​

200 : Success

{
"stats": {
"status": "active",
"available_content": 12,
"consumed_content": 7,
"app_timespent": 5400
},
"user_id": 83,
"user_name": "Jane Doe",
"user_email": "jane@example.com",
"user_desg": "Sales Manager",
"user_image_url": "",
"channel_id": 12,
"channel_name": "acme",
"app_name": "Acme Corp",
"user_reg_date": "2026-03-14 10:22:41",
"user_last_app_activity": "2026-09-10 08:15:03",
"user_group": [
{
"grp_id": 5,
"grp_name": "Sales"
}
],
"is_admin": false
}

404 : User not found

{
"error": 404,
"message": "User Not Found.",
"reason": ""
}