Users Count

Purpose

To fetch the total number of users in your org.

Request Details

Request URL

{api-domain}/crm/{version}/users/actions/count

Header

Authorization: Zoho-oauthtoken <access_token>

Scope

Scope = ZohoCRM.Users.READ
OR
Scope = ZohoCRM.Users.ALL

Parameters
  • typestring, optional

    Specify the type of the users whose count you want to retrieve.

    • AllUsers - To list the count of all users in your organization.
    • ActiveUsers - To get the count of all the Active Users.
    • DeactiveUsers - To get the count of all the users who were deactivated.
    • ConfirmedUsers - To get the count of all the confirmed users.
    • NotConfirmedUsers - To get the count of all the non-confirmed users.
    • DeletedUsers - To get the count of deleted users.
    • ActiveConfirmedUsers - To get the count of active users who are also confirmed.
    • AdminUsers - To get the count of admin users.
    • ActiveConfirmedAdmins - To get the count of active users with the administrative privileges and are also confirmed.
    • CurrentUser - To get count of the current CRM user. This will always return 1.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/users/actions/count"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • OAUTH_SCOPE_MISMATCHHTTP 401

    You do not have the scope required to use this API.
    Resolution: Use the correct scope and generate the grant and access tokens.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: Use the correct URL pattern to make API calls.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: The HTTP method for this request should be GET.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed
    Resolution: Use proper authentication and make the API call.

Sample Response

Copied{
    "count": 11
}