Get a user by id
GET
/v1/identity/users/{userId}
const url = 'https://example.com/v1/identity/users/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/identity/users/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”userId
required
string
Responses
Section titled “Responses”User record.
Media typeapplication/json
Tenant-scoped user record (admin plane). primaryEmail may be redacted on the wire based on tenant policy (the routes treat it as opaque). metadata is free-form JSON — deployments carry IdP claims / provisioning source / roles here.
object
userId
required
string
tenantId
required
string format: uuid
primaryEmail
string
displayName
string
createdAt
required
string format: date-time
lastActiveAt
string format: date-time
metadata
object
key
additional properties
any
Examplegenerated
{ "userId": "example", "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "primaryEmail": "example", "displayName": "example", "createdAt": "2026-04-15T12:00:00Z", "lastActiveAt": "2026-04-15T12:00:00Z", "metadata": {}}Missing / malformed / expired / revoked bearer token.
Media typeapplication/json
object
error
required
object
code
required
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
string
message
required
string
details
Optional, kind-specific.
object
key
additional properties
any
requestId
required
Server-assigned request id; also echoed via X-Request-Id header.
string
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}No user with that id under this tenant.
Media typeapplication/json
object
error
required
object
code
required
Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).
string
message
required
string
details
Optional, kind-specific.
object
key
additional properties
any
requestId
required
Server-assigned request id; also echoed via X-Request-Id header.
string
Examplegenerated
{ "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" }}