Get records from a Team Pipeline
Retrieve the pipeline records from a specific Team Pipeline.
Endpoints
Request URL
{api-domain}/bigin/v2/Pipelines
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 the following scope:
- ZohoBigin.modules.Pipelines.ALL
Request parameters
The available request parameters are given below:
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.
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 pipeline records and include fields like Deal_Name and Stage, you can pass them as fields=Deal_Name,Stage.
You can pass up to 50 fields.
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.
sort_order stringOptional
Specify the sorting order for list of records. It can be asc for ascending order or desc for descending order.
sort_by stringOptional
Specify the field API name based on which the records will be sorted. The supported fields are id, Created_Time, and Modified_Time.
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/Pipelines?pipeline_id=2034020000000095023&fields=Deal_Name,Sub_Pipeline,Stage,Closing_Date&page=1&per_page=10" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/Pipelines?pipeline_id=2034020000000095023&fields=Deal_Name,Sub_Pipeline,Stage,Closing_Date&page=1&per_page=10"
type: GET
connection:"connection_link_name"
];
info response;Response object
The response object contains a list of pipeline records belonging to a particular Team Pipeline, 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": [
{
"Deal_Name": "City Tour Package",
"Stage": "Qualification",
"id": "2034020000000478136",
"Closing_Date": "2023-05-31",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Cruise Package",
"Stage": "Proposal/Price Quote",
"id": "2034020000000478164",
"Closing_Date": "2023-06-20",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Ski Vacation Package",
"Stage": "Negotiation/Review",
"id": "2034020000000478192",
"Closing_Date": "2023-07-05",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Luxury Getaway Package",
"Stage": "Needs Analysis",
"id": "2034020000000478220",
"Closing_Date": "2023-07-31",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Cultural Tour Package",
"Stage": "Closed Won",
"id": "2034020000000478248",
"Closing_Date": "2023-08-15",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Wildlife Safari Package",
"Stage": "Proposal/Price Quote",
"id": "2034020000000478276",
"Closing_Date": "2023-08-31",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Food and Wine Tour Package",
"Stage": "Closed Lost",
"id": "2034020000000478304",
"Closing_Date": "2023-09-15",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Wellness Retreat Package",
"Stage": "Negotiation/Review",
"id": "2034020000000478332",
"Closing_Date": "2023-09-30",
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Beach Vacation Package Research",
"Stage": "Market Research",
"id": "2034020000000478382",
"Closing_Date": null,
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
},
{
"Deal_Name": "Adventure Tour Campaign Planning",
"Stage": "Campaign Planning",
"id": "2034020000000478392",
"Closing_Date": null,
"Pipeline": {
"name": "Sales - Marketing",
"id": "2034020000000095023"
}
}
],
"info": {
"per_page": 10,
"next_page_token": "7e735c394ae76c6eae4a74b2700dfbbd6e11b64a3b86f3aabb17486c5cf92e96036a423fbc13307e953f04ba4bec79615f6df14fd9307c8dd312f31832529082cad036afbbeeef53113d65e438257862e589271700296d817153bdd649239a156e3b1a204dc86c53fa1b17ec7aac5cd11b872eaafb414f08a1f2fc77d5a51f92b8b7bb7fef9ddc6694e7fce8c610d854",
"count": 10,
"sort_by": "id",
"page": 1,
"previous_page_token": null,
"page_token_expiry": "2023-07-17T12:19:35+05:30",
"sort_order": "asc",
"more_records": true
}
}