Get all pipelines | Brevo API Documentation

Retrieve the list of all deal pipelines configured for your account, including each pipeline''s stages and settings. If no pipelines have been configured yet, a default pipeline is automatically created and returned.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Response

Returns list of pipelines and their details

pipelinestring

Pipeline id

pipeline_namestring

Pipeline Name

stageslist of objects

List of pipeline stages

Errors

400

Bad Request Error

The API key should be passed in the request headers as api-key for authentication.

Returns list of pipelines and their details

List of pipeline stages

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.deals.getAllPipelines();
8	}
9	main();

1	[
2	{
3	"pipeline": "5ea675e3da0dd085acaea610",
4	"pipeline_name": "Sales Pipeline",
5	"stages": [
6	{
7	"id": "9e577ff7-8e42-4ab3-be26-2b5e01b42518",
8	"name": "New"
9	}
10	]
11	}
12	]

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.deals.getAllPipelines();
8	}
9	main();

1	[
2	{
3	"pipeline": "5ea675e3da0dd085acaea610",
4	"pipeline_name": "Sales Pipeline",
5	"stages": [
6	{
7	"id": "9e577ff7-8e42-4ab3-be26-2b5e01b42518",
8	"name": "New"
9	}
10	]
11	}
12	]