Agent Availability Attributes

The attributes of an agent's availability (part of the Agent Availabilities JSON response format).

JSON format

Agent Availability Attributes are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
agent_id integer false true The agent's Zendesk ID.
agent_status object false false Agent Status. Returned only if Omnichannel Contact Center is enabled.
group_ids array false false The IDs of the groups that the agent belongs to, if known. To get the name of a group, you can use the Show Group endpoint.
skills array false false The IDs of the skills attributed to the agent, if known. To get the name of a skill, you can use the Show Attribute Value endpoint.
version integer false true The version number of the agent's availability.

Agent Availability Attributes.

Example

{  "agent_id": 10011,  "agent_status": {    "id": 1,    "name": "online",    "reason": "UNKNOWN",    "updated_at": "2022-06-21T10:23:25.583732Z"  },  "group_ids": [    1  ],  "skills": [    {      "id": "1ae11c11-9993-49f8-9850-c2dc096badd1"    }  ],  "version": 236}