Users / Get one

Return specific user.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/users/{id}

Method: GET

Authorisation: Minimum role: USER

Request Arguments
Name Type Source
idInt32

  Request body example

Response object

Response status: 200 (OK)

Response type: DTO_user

Wrapper: DTO_response_wrap

Other response statuses: 400 (BadRequest), 403 (Forbidden)

  Response body example

DTO_user
NameTypeReadOnlyDescription
tenant_userDTO_tenant_userTenant user
created_byDTO_reference_userReadOnlyCreated by
last_updated_byDTO_reference_userReadOnlyLast updated by
languageDTO_translation_languageReadOnlyLanguage
admin_rolesadmin_role[]ReadOnlyAdmin roles held by the user. Empty list = not an admin (normal app user). A user may hold multiple roles simultaneously.
permissionsadmin_permission[]ReadOnlyGranular admin permissions. Empty unless at least one admin_role is held. Ignored for SUPER_ADMIN.
idInt32ReadOnlyId
emailStringEmail
given_nameStringGiven name
family_nameStringFamily name
full_nameStringReadOnlyName
profile_picStringReadOnlyProfile pic
createdDateTimeReadOnlyCreated
last_updatedDateTimeReadOnlyLast updated
display_absolute_timeBooleanReadOnlyDisplay absolute time
is_deletedBooleanReadOnlyIs deleted
DTO_tenant_user
NameTypeReadOnlyDescription
groupsDTO_reference_is_admin[]Groups
brand_usersDTO_brand_user[]Brands within this tenant that the user has explicit BrandUser access to. SUPER_ADMIN / OWNER / ADMIN tenant-wide brand access is not expanded here — the FE should derive that from + .
idInt32ReadOnlyId
tenant_idInt32Tenant id
user_idInt32User id
roleENUM tenant_user_roleTenant role
statusENUM tenant_user_statusStatus
last_seenDateTimeLast seen
DTO_reference_is_admin
NameTypeReadOnlyDescription
is_adminBooleanReadOnlyIs admin
idInt32Id
labelObjectReadOnlyLabel
DTO_brand_user
NameTypeReadOnlyDescription
tenant_idInt32Tenant id
brand_idInt32Brand id
roleENUM brand_user_roleRole
DTO_reference_user
NameTypeReadOnlyDescription
profile_picStringReadOnlyProfile pic
emailStringReadOnlyEmail
role_enum_idtenant_user_role (nullable)Role enum id
idInt32Id
labelObjectReadOnlyLabel
DTO_translation_language
NameTypeReadOnlyDescription
idInt32ReadOnlyLeave empty on input
nameStringName
codeStringCode
iconStringReadOnlyIcon
icon_sqareStringReadOnlyIcon sqare
ENUM tenant_user_role
ValueNameDescription
0UNKNOWNUNKNOWN
1OWNEROwner
2ADMINAdmin
3USERUser
ENUM tenant_user_status
ValueNameDescription
0UNKNOWNUNKNOWN
1ACTIVEACTIVE
2DEACTIVEDEACTIVE
ENUM brand_user_role
ValueNameDescription
0UNKNOWNUNKNOWN
1USERUser
2READ_ONLYRead only