Home//
REST API Reference
/- Admin
Teammate Office Hours
Activity Log Event Types
Identify an admin
Set an admin to away
List all activity logs
Search activity logs
List all activity log event types
List all admins
List teammate office hours
Update teammate office hours in bulk
Retrieve teammate office hours
Update teammate office hours
Find an admin by email
Retrieve an admin
Remove an admin
Admin
Admins are teammate accounts that have access to a workspace.
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Example:false
The unique identifier of the away status reason. Not returned by List all admins.
Example:12345
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
Example:true
The ids of the teams the admin belongs to. When the workspace has a default team, its id is the last item.
Example:
[ 814865 ]
The teammate's avatar image. On List all admins it is only included when display_avatar is true. Elsewhere it is left out when the teammate has neither an uploaded avatar nor a gravatar.
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": { "type": "avatar", "image_url": "https://picsum.photos/200/300" }, "team_priority_level": { "primary_team_ids": [ … ], "secondary_team_ids": [ … ] }, "role": { "type": "role", "id": "1", "name": "Support Agent" } }