AccountUsersResponse

Response schema for multiple account users

data object[]

The account users details

Array [

objectstringrequired

String representing the object's type.

Possible values: [account_user]

passivebooleanrequired

Whether this user is passive. Passive users do not receive direct email notifications (e.g., OAuth reconnection notices).

roles object[]required

The roles assigned to the user in this account.

Array [

denied_permissionsstring[]required

Permissions explicitly denied for this role. Denials win over grants, including wildcards (e.g. denying appointments.own.cancel removes cancel even when the role has appointments.own.*). Superuser roles cannot have denials.

idstringrequired

Unique identifier for the role.

Possible values: Value must match regular expression ^role_\w{12}$

namestringrequired

The name of the role.

objectstringrequired

String representing the object's type.

Possible values: [role]

permissionsstring[]required

Granted permissions for this role. Built-in roles return their baseline grants; custom roles return the stored allow-list. Explicit denials are listed separately in denied_permissions and always win over grants (including wildcards).

typestringrequired

The type of the role.

Possible values: [admin, staff, superuser, custom]

]

user objectrequired

This is an object representing a user of the app.

created_atdate-timerequired

Time at which the object was created.

emailemailrequired

The user's email address.

first_namestringrequired

The user's first name.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^user_\w{12}$

last_namestringrequired

The user's last name.

objectstringrequired

String representing the object's type.

Possible values: [user]

updated_atdate-timerequired

Time at which the object was last updated.

]

AccountUsersResponse

{
  "data": [
    {
      "object": "account_user",
      "passive": false,
      "roles": [
        {
          "denied_permissions": [
            "appointments.own.cancel",
            "appointments.own.reschedule"
          ],
          "id": "role_123456789012",
          "name": "Staff",
          "object": "role",
          "permissions": [
            "accounts.view",
            "appointments.own.*",
            "blocks.*",
            "booking_intents.*",
            "clients.*",
            "integrations.own.*",
            "providers.own.view",
            "providers.own.update"
          ],
          "type": "staff"
        }
      ],
      "user": {
        "created_at": "2025-03-15T13:01:08Z",
        "email": "avery@tendermedical.com",
        "first_name": "Avery",
        "id": "user_d025a96ac0c6",
        "last_name": "Evans",
        "object": "user",
        "updated_at": "2025-03-15T13:01:08Z"
      }
    }
  ]
}