Get an internal user
Retrieves a single internal user (portal team member) by ID.
Authorizations
Path Parameters
ID of the internal user to retrieve
Response
OK
AvatarImageUrl is the URL of the internal user's avatar image. Read-only.
"https://portal.example.com/avatars/jordan.png"
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.
Created is the RFC 3339 timestamp at which the object was created.
"2024-01-15T09:30:00Z"
Deleted is true when the object has been deleted; present only on delete responses.
true
Email is the internal user's email address, used as the unique login identifier within the portal.
"jordan.lee@example.com"
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.
^#[0-9a-fA-F]{6}$"#4F46E5"
FamilyName is the internal user's last (family) name.
"Lee"
GivenName is the internal user's first (given) name.
"Jordan"
ID is the unique identifier of the object.
"550e8400-e29b-41d4-a716-446655440000"
IsClientAccessLimited is true when the internal user can only access the companies listed in companyAccessList; false (or null) grants access to all companies.
true
Object is the type of the object (e.g. "client", "company").
client, internalUser, company, customField, customFieldOption, file, fileChannel, folder, messageChannel, message, notification Role is the internal user's role within the portal.
"admin"
Updated is the RFC 3339 timestamp at which the object was last updated.
"2024-02-20T14:05:00Z"