Related lists

Overview

The Related List is an associated record that gives you extra information like notes, attachments, products, deals, contacts, etc. You can use the related lists API to access all the related data for a complete view of the record details.

Endpoints

GET /{module_api_name}/{record_id}/{related_list_api_name}

Get related list records

Retrieve the related list records associated with a record.

Request URL

{api-domain}/bigin/v2/{module_api_name}/{record_id}/{related_list_api_name}

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, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

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 one of the following scopes:

ZohoBigin.modules.ALL
ZohoBigin.modules.{module_name}.ALL
ZohoBigin.modules.{module_name}.READ

In the above scope, replace {module_name} with the necessary. The possible modules include pipelines, contacts, accounts (companies in Bigin), and products.

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

record_id stringRequired

The unique identification of a record in a module. You can get the record ID from the Get records API.

related_list_api_name stringRequired

The API name of the related list. The supported related lists for the specified module can be obtained from Get related lists metadata API.

Query parameters

fields stringRequired

Specify the fields you want to retrieve in the API response. It accepts multiple field API names separated by commas. You can get the field API names from the Fields Metadata API by accessing the api_name value for each field. For example, if you want to fetch module records and include fields like Last_Name and Email, you can pass them as fields=Last_Name,Email.

page integerOptional

Represents the page index. This parameter lists the records from the given page index. The default value is 1.

per_page integerOptional

Represents the number of records per page index. The default value is 200, which means up to 200 records can be retrieved per page index.

Notes: The page and per_page parameters are utilized when you want to fetch more than 200 records. Since the maximum number of records per API call is 200, fetching records beyond the 200th position is not possible in a single call. However, by making two API calls with page values of 1 and 2 and a per_page value of 200, all 400 records can be retrieved.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/2034020000000478028/Pipelines?fields=Deal_Name,Sub_Pipeline,Stage,Pipeline" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response object

The response object contains a list of related list records belonging to the specified record, filtered based on the query parameters provided.

Possible error codes

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

Sample response

Copied{
    "data": [
        {
            "Contact_Role": null,
            "Deal_Name": "Wildlife Safari Package",
            "Stage": "Proposal/Price Quote",
            "id": "2034020000000478276",
            "Sub_Pipeline": "Sales Pipeline Standard",
            "Pipeline": {
                "name": "Sales - Marketing",
                "id": "2034020000000095023"
            }
        },
        {
            "Contact_Role": null,
            "Deal_Name": "City Tour Package",
            "Stage": "Qualification",
            "id": "2034020000000478136",
            "Sub_Pipeline": "Sales Pipeline Standard",
            "Pipeline": {
                "name": "Sales - Marketing",
                "id": "2034020000000095023"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "next_page_token": null,
        "count": 2,
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": null,
        "more_records": false
    }
}