Skip to content
Home/
REST API Reference
/
/
Admin

Admin

Admins are teammate accounts that have access to a workspace.

typestring

String representing the object's type. Always has the value admin.

Example:"admin"
idstring

The id representing the admin.

Example:"1295"
namestring

The name of the admin.

Example:"Joe Example"
emailstring

The email of the admin.

Example:"jdoe@example.com"
job_titlestring

The job title of the admin.

Example:"Associate"
away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

Example:false
away_mode_reassignboolean

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example:false
away_status_reason_idinteger or null

The unique identifier of the away status reason

Example:12345
has_inbox_seatboolean

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example:true
team_idsArray of integers

This object represents the avatar associated with the admin.

Example:
[
  814865
]
avatarstring or null, (uri)

Image for the associated team or teammate

Example:"https://picsum.photos/200/300"
team_priority_levelobject or null(Team Priority Level)

Admin priority levels for teams

{
  "type": "admin",
  "id": "1295",
  "name": "Joe Example",
  "email": "jdoe@example.com",
  "job_title": "Associate",
  "away_mode_enabled": false,
  "away_mode_reassign": false,
  "away_status_reason_id": 12345,
  "has_inbox_seat": true,
  "team_ids": [
    814865
  ],
  "avatar": "https://picsum.photos/200/300",
  "team_priority_level": {
    "primary_team_ids": [ … ],
    "secondary_team_ids": [ … ]
  }
}