Skip to content
CalypsoAI
Search
K
Main Navigation
App
Product docs
Appearance
Menu
Return to top
Get user.
GET
/backend/v1/users/{userId}
Retrieves a user by their ID.
Authorizations
HTTPBearer
Type
HTTP (bearer)
Parameters
Path Parameters
userId
*
Type
string
Required
Query Parameters
includeRoles
Include the user's roles in the response
Type
boolean
default
false
Responses
200
422
Successful Response
Content-Type
application/json
Schema
JSON
JSON
{
"roles"
:
{
"additionalProperties"
:
{
}
}
,
"user"
:
{
"admin"
:
"string"
,
"blocked"
:
false
,
"createdAt"
:
"string"
,
"email"
:
"string"
,
"id"
:
"string"
,
"lastInvitationSentAt"
:
"string"
,
"machine"
:
false
,
"name"
:
"string"
,
"org"
:
"string"
,
"permissions"
:
[
[
]
]
,
"roleIds"
:
[
[
]
]
,
"roles"
:
[
[
]
]
,
"social"
:
false
,
"teams"
:
[
[
]
]
,
"verified"
:
true
}
}
GET
/backend/v1/users/{userId}
Playground
Server
Select a server...
Authorization
HTTPBearer
Variables
Key
Value
userId
*
includeRoles
Try it out
Samples
Powered by
VitePress OpenAPI