Records count in a module

Retrieve the count or number of records available in a module.

Request URL


Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

  • For US,
  • For EU,
  • For AU,
  • For IN,
  • For CN,
  • For JP,

For more information, see Multi DC Support.



For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with the following scopes:

  • ZohoSearch.securesearch.READ and ZohoBigin.modules.{module_name}.READ

In the above scope, replace {module_name} with the module for which you want to retrieve the records count. The possible modules include pipelines, contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

ModuleAPI Name

Sample request

Copiedcurl "" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
	url: ""
	type: GET
info response;

Response object

The response object contains the following details:

count integer

Indicates the number of records that are available in a specified module.


Possible error codes

The response of this resource includes HTTP status and error codes.

Sample response

"count": 10