Skip to content
Home/
REST API Reference
/
/
Admin

Admin

Admins are the teammate accounts that have access to a workspace

typestringrequired

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

Value:"admin"
Example:"admin"
idstringrequired

The id representing the admin.

Example:"1295"
namestringrequired

The name of the admin.

Example:"Hoban Washburne"
emailstringrequired

The email of the admin.

Example:"wash@serenity.io"
job_titlestringrequired

The job title of the admin.

Example:"Philosopher"
away_mode_enabledbooleanrequired

Identifies if this admin is currently set in away mode.

Example:false
away_mode_reassignbooleanrequired

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

Example:false
has_inbox_seatbooleanrequired

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

Example:true
team_idsArray of integersrequired

This is a list of ids of the teams that this admin is part of.

Example:
[
  814865
]
avatarobject

This object represents the avatar associated with the admin.

email_verifiedboolean or null

Identifies if this admin's email is verified.

Example:true
appobject or null(App)

App that the admin belongs to.

{
  "type": "admin",
  "id": "1295",
  "name": "Hoban Washburne",
  "email": "wash@serenity.io",
  "job_title": "Philosopher",
  "away_mode_enabled": false,
  "away_mode_reassign": false,
  "has_inbox_seat": true,
  "team_ids": [
    814865
  ],
  "avatar": {
    "type": "avatar",
    "image_url": "https://example.com/avatar.png"
  },
  "email_verified": true,
  "app": {
    "type": "app",
    "id_code": "xyz789",
    "name": "ACME",
    "region": "US",
    "timezone": "America/Los_Angeles",
    "created_at": 1671465577,
    "identity_verification": false
  }
}