This page provides an API reference for retrieving a user by ID (id). It includes endpoint details, required parameters, example requests, and responses. Use this API when you need to query users by their IDs.
Retrieve a user ID
Retrieve a user’s ID (id).
Endpoint
GET /v2/users/{id}
| Parameter name | In | Type | Required? | Description |
|---|---|---|---|---|
|
Path |
String |
Yes |
The user ID to query |
Responses
The following table outlines the possible responses for this endpoint, including status codes, their meanings, and the schemas that describe the structure of the returned data or errors:
| Status Code | Description | Schema |
|---|---|---|
200 |
Success. Returns a list of users corresponding to the requested IDs |
|
Default |
Error. Occurs when the user ID is missing, invalid, or the requester lacks permission. |
|
Response example
{ "user": { "id": <1>, "givenname": "<string>", "familyname": "<string>", "displayname": "<string>", "usertype": "<int>", "userstatus": "<int>", "loginids": "[]<string>", "preferences": "map<string, string>", "audit": { “who”: ”<1>", “when”: ”<timestamp>", “why”: ”<reason for the update> }, "logins": []{ "id": <string>, "type": <int>, "email": <string>, "is_verified": <bool>, "user_id": <string>, } } }