Skip to main content
GET
/
users
/
{id-or-identifier}
Retrieve a user by id or identifier
curl --request GET \
  --url http://localhost:{port}/users/{id-or-identifier} \
  --header 'Authorization: Bearer <token>'
{
  "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
  "identifier": "ben",
  "name": "Benjamin Zhang",
  "email": "[email protected]",
  "user_type": "saas_admin",
  "status": "active",
  "created_at": "2023-05-06T00:00:00Z",
  "updated_at": "2023-05-06T00:00:00Z",
  "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
  "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Version
enum<string>
default:v1

Your API version

Available options:
v1
​
Content-Type
enum<string>
Available options:
application/json,
application/xml,
application/x-www-form-urlencoded,
application/octet-stream,
application/pdf,
text/plain,
text/html,
multipart/form-data

Path Parameters

​
id-or-identifier
string
required

Response

Success

​
id
string<uuid>
required
Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

​
identifier
string
required
Example:

"ben"

​
name
string
required
Example:

"Benjamin Zhang"

​
email
string<email>
required
​
user_type
enum<string>
required
Available options:
saas_admin,
saas_user,
saas_user_client
Example:

"saas_user"

​
status
enum<string>
required
Available options:
active,
onboarding,
inactive,
suspended,
risky
Example:

"active"

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
created_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

​
updated_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"