Skip to main content

AccountUser

This is an object representing a user in an account.

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 [
  • 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]

    typestringrequired

    The type of the role.

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

  • ]
  • user objectrequired

    This is an object representing a user of the app.

    created_atstring<date-time>required

    Time at which the object was created.

    emailstring<email>required

    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_atstring<date-time>required

    Time at which the object was last updated.

    AccountUser
    {
    "object": "account_user",
    "passive": false,
    "roles": [
    {
    "id": "role_123456789012",
    "name": "Admin",
    "object": "role",
    "type": "admin"
    }
    ],
    "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"
    }
    }