Skip to main content
GET
GET /v1/users/{id}

Retrieve a User

Get a single user by its unique ID or fully qualified name.

Get by ID

string
required
UUID of the user to retrieve.
string
Comma-separated list of fields to include (e.g., teams,roles,personas,domains,follows,owns).
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/users/name/{fqn} to retrieve by fully qualified name.
string
required
Fully qualified name of the user (e.g., aaron_johnson0).
string
Comma-separated list of fields to include: teams, roles, personas, domains, follows, owns.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/users/{id}

Returns

Returns a user object with all requested fields populated.

Response

string
Unique identifier for the user (UUID format).
string
Username.
string
Fully qualified name (same as name for users).
string
Human-readable display name.
string
Email address of the user.
boolean
Whether this user is a bot account.
boolean
Whether this user has admin privileges.
array
Teams the user belongs to. Only included when fields contains teams.
array
Roles assigned to the user. Only included when fields contains roles.
array
Personas assigned. Only included when fields contains personas.
array
Domain assignments. Only included when fields contains domains.
array
Entities the user follows. Only included when fields contains follows.
array
Entities owned by the user. Only included when fields contains owns.
number
Version number for the entity.

Error Handling