Retrieving the total number of agents in your Zoho Desk portal is straightforward via the REST API — a single GET request returns the count you need for reporting, capacity planning, or automation workflows.
Why this matters
Knowing your active agent count is essential when auditing license usage, building dashboards, or triggering automated workflows that depend on team size. Zoho Desk exposes a dedicated endpoint for this purpose, so you don't need to paginate through a full agent list and count manually. This is particularly useful for administrators managing billing seats or developers integrating Zoho Desk data into external systems. [7]
> Beam Help is an independent expert support resource for Zoho products — we are not official Zoho support.
---
Step-by-step
Step 1. Ensure you have a valid OAuth 2.0 token (or API key) with the appropriate Zoho Desk scope that permits read access to agent data. Without proper authentication, the request will be rejected before it reaches the agent resource. [2]
Step 2. Send an HTTP GET request to the following endpoint on your Zoho Desk instance: [2]
GET /api/v1/agents/count
This is the dedicated operation (getagentscount) that returns the total number of agents in your portal. [2]
Step 3. Optionally, pass query parameters using the p argument if your integration requires filtering or pagination context. The endpoint accepts a parameter object (p) that can be supplied as a query string. [2]
Step 4. If you are calling this from Python (for example, inside a Zoho Desk SDK wrapper or a custom script), the call looks like this: [2]
def get_agents_count(self, p: dict = None):
"""Get Agents Count"""
return self.c.request("GET", "/api/v1/agents/count", p, None)
Pass any optional filter parameters as a dictionary to p, or leave it as None for a plain total count. [2]
Step 5. Parse the JSON response body. The returned payload will contain the agent count figure you can use in your reporting logic, billing audits, or downstream automation. [2]
---
Common pitfalls
- Authentication errors: The most frequent issue is an expired or incorrectly scoped OAuth token. Make sure your token includes read permissions for the agents resource before calling the endpoint. [2]
- Confusing agent count with license seats: The API returns the number of agents currently configured in your portal. This may differ from the number of *purchased* license seats visible in your billing panel — unused seats are not reflected as agents. [7]
- Agents vs. contacts: Agents are the support staff who log in to Zoho Desk and handle tickets. Do not confuse this endpoint with contact or end-user counts, which are managed through a separate resource. [8]
---
What to check
- Confirm the count matches your Admin panel: After calling the endpoint, cross-reference the returned number against Setup > User Management in your Zoho Desk portal to verify accuracy. [1]
- Verify billing alignment: Compare the agent count from the API with the number of active license seats under your subscription to ensure you are not over- or under-provisioned. [7]
- Test authentication scope: If the request returns an authorization error rather than a count, review the OAuth scopes attached to your token and confirm agent-read access is explicitly granted. [2]