Internal Users

This resource represents an internal user in your portal.

Properties

id string
The unique identifier for this item.

createdAt string
The date this item was created in RFC3339 format.

object string
The object type of this resource.

givenName string
The internal user’s given name (first name).

familyName string
The internal user’s family name (last name).

email string
The internal user’s email.

role string
The role of the internal user. Can be admin or staff

isClientAccessLimited bool
The access level for the user. When false the user has full access and when true the user has limited access. See more

companyAccessList string[]
The list of companyIds that this user has access to. This is only relevant when isClientAccessLimited is true. Since clients are part of companies, this user will have access to any client that belongs to a company in this list.

Note that the companies in this list also include placeholder companies.

{
    "id": "a34b3206-c567-4185-aad5-124ef6ea2b0b",
    "object": "internalUser",
    "createdAt": "2023-06-23T14:40:29.632217267Z",
    "givenName": "Ari",
    "familyName": "Quinones",
    "email": "[email protected]",
    "role": "admin",
    "isClientAccessLimited": true,
    "companyAccessList": [
        "00d31640-a863-44a1-a844-5b3a16f72bb0",
        "1ad25040-c5dc-4c98-a182-c6610d1a799c",
        "c7a8cdd0-7260-459c-9c13-77af594005b6"
    ]
}