Get User

Returns a single user by ID, including non-activated users. Returns 404 if the user does not exist, belongs to a different business, or has an internal platform role (SUPER_ADMIN, SUPER_MANAGER).

Requires scope: users:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
User ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the user.
firstNamestring
User's first name.
lastNamestring
User's last name.
fullNamestring

User’s full display name (first name + last name).

emailstring

User’s email address (used for login).

roleenum

Role assigned to this user. Internal platform roles (SUPER_ADMIN, SUPER_MANAGER) are never returned by this API.

activatedboolean
Whether the user account is active and able to log in.
createdAtdatetime
ISO 8601 timestamp when the user account was created.
phoneNumberstring
User's phone number.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error