Get Sources Count

Purpose

To get the number of users, groups, roles, and territories available in a user group.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/user_groups/{groupid}/actions/sources_count

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.user_groups.READ

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v4/settings/user_groups/3652397000009952001/actions/sources_count"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

Response JSON Keys

  • usersJSON Object

    The number of active, inactive and deleted users in this group.

  • rolesinteger

    The number of roles present in this group.

  • territoriesinteger

    The number of territories present in this group.

  • groupsinteger

    The number of groups present in this user group.

Possible Errors

  • INVALID_DATAHTTP 400

    The group Id is incorrect in the URL.
    Resolution: Specify a valid group ID. Use the Get User Groups API to get the ID of the user group.

Sample Response

Copied{
    "sources_count": [
        {
            "territories": 2,
            "roles": 2,
            "groups": 0,
            "users": {
                "inactive": 0,
                "deleted": 0,
                "active": 2
            }
        }
    ]
}