Retrieve Account User

Beta
GET/v1/identity/account-users/{id}

This endpoint is idempotent. Learn more

Returns an account user by ID.

idstring

Account user ID.

include[]optional arrayenumValues:roledepartment

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

namestringnullable

Display name.

emailstringnullable

Email address.

usernamestringnullable

Username.

image_urlstringnullable

Profile image URL.

statusstringenumValues:activedisabledremoved

Account user status.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

The role's type is sometimes used to gate special behaviors in the frontend and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.
permissionsarray of stringnullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentobjectExpandablenullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

Always returned as null in this endpoint.
scanning_stationsobjectnullable

Scanning stations in this department.

Always returned as null in this endpoint.
machinesobjectnullable

Machines in this department.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

last_used_atstring (date-time)nullable

When the user last used this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

Responses

200

Successful response for Retrieve Account User