Records count in a module
Retrieve the count or number of records available in a module.
Endpoints
Request URL
Bigin APIs are available across eight different domains, and you must choose the one relevant to your data center (DC):
- US
- EU
- AU
- IN
- CN
- JP
- SA
- CA
Authorization
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:
Module | API Name |
|---|---|
Contacts | Contacts |
Pipelines | Pipelines |
Companies | Accounts |
Products | Products |
Tasks | Tasks |
Events | Events |
Calls | Calls |
Sample request
Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/actions/count" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Pipelines/actions/count"
type: GET
connection:"connection_link_name"
];
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
Copied{
"count": 10
}