Get the Team Pipeline records related to a specific contact

Retrieve a specific Team Pipeline records associated with a particular contact.

Endpoints

Request URL

{api-domain}/bigin/v2/Contacts/{contact_id}/Pipelines?pipeline_id={pipeline_id}

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.Pipelines.ALL and ZohoBigin.modules.Contacts.ALL

Request parameters

The available request parameters are given below:

Path parameters

contact_id stringRequired

The unique identification (contact_id) of a Contact. You can get the Contact ID from the Get records API.

Query parameters

pipeline_id stringRequired

The unique identification (pipeline_id) of a Team Pipeline. You can get the pipeline ID from the Layouts Metadata API by accessing the id value of a Team Pipeline.

Sample request

Curl Deluge

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

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Contacts/2034020000000478028/Pipelines?pipeline_id=2034020000000645063&fields=Deal_Name,Sub_Pipeline,Stage,Closing_Date"
	type: GET
	connection:"connection_link_name"
];
info response;

Response object

The response object contains a list of pipeline records that belong to a specific Team Pipeline and are associated with a particular contact.

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",
            "Closing_Date": "2023-08-31"
        },
        {
            "Contact_Role": null,
            "Deal_Name": "City Tour Package",
            "Stage": "Qualification",
            "id": "2034020000000478136",
            "Sub_Pipeline": "Sales Pipeline Standard",
            "Closing_Date": "2023-05-31"
        }
    ],
    "info": {
        "per_page": 200,
        "next_page_token": null,
        "count": 2,
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": null,
        "more_records": false
    }
}