Get agents count

GET {{baseUrl}}/api/v1/agents/count

This API lists the agents count by status, confirmed and include light

OAuth Scope

  • Desk.settings.READ
  • Desk.basic.READ

Request Params

KeyDatatypeRequiredDescription
statusstringParameter that filters agents based on their activation status: ACTIVE or DISABLED
isConfirmedstringFilters Confirmed & Unconfirmed agents
includeLightAgentstringCount light agent.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"count":5}