Skip to main content
GET
Get an internal user

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

ID of the internal user to retrieve

Response

OK

avatarImageUrl
string<uri>

AvatarImageUrl is the URL of the internal user's avatar image. Read-only.

Example:

"https://portal.example.com/avatars/jordan.png"

companyAccessList
string[] | null

CompanyAccessList is the set of company IDs the internal user can access when isClientAccessLimited is true. Empty when the user has access to all companies.

Example:
createdAt
string<date-time>

Created is the RFC 3339 timestamp at which the object was created.

Example:

"2024-01-15T09:30:00Z"

deleted
boolean

Deleted is true when the object has been deleted; present only on delete responses.

Example:

true

email
string<email>

Email is the internal user's email address, used as the unique login identifier within the portal.

Example:

"jordan.lee@example.com"

fallbackColor
string

FallbackColor is the hex color (e.g. "#4F46E5") used as the avatar background when no avatar image is set. The native pattern documents intent; the constraint is re-applied to the spec by the enrich-openapi post-processing step.

Pattern: ^#[0-9a-fA-F]{6}$
Example:

"#4F46E5"

familyName
string

FamilyName is the internal user's last (family) name.

Example:

"Lee"

givenName
string

GivenName is the internal user's first (given) name.

Example:

"Jordan"

id
string

ID is the unique identifier of the object.

Example:

"550e8400-e29b-41d4-a716-446655440000"

isClientAccessLimited
boolean | null

IsClientAccessLimited is true when the internal user can only access the companies listed in companyAccessList; false (or null) grants access to all companies.

Example:

true

object
enum<string>

Object is the type of the object (e.g. "client", "company").

Available options:
client,
internalUser,
company,
customField,
customFieldOption,
file,
fileChannel,
folder,
messageChannel,
message,
notification
role
string

Role is the internal user's role within the portal.

Example:

"admin"

updatedAt
string<date-time>

Updated is the RFC 3339 timestamp at which the object was last updated.

Example:

"2024-02-20T14:05:00Z"