GET /v1/pipelines
const url = 'https://seu-endereco-da-api/v1/pipelines';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/pipelines \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler negócios (deals:read), ou Gerenciar fluxos (flows:manage), ou Gerenciar sequências (sequences:manage), ou Gerenciar disparos automáticos (automations:manage).
Authorizations
Seção intitulada “Authorizations”Responses
Seção intitulada “Responses”Who builds flows, sequences or automations without deals:read gets the structure with openCount and openValueCents null
object
object
object
Sales for the commercial funnel, management for a pipeline that tracks internal work; set when the pipeline is created
Singular name of each item of this board (client, case, process or custom); null uses the default of the type
Plural name of each item of this board; null exactly when itemLabelOne is null
Stale limit a new stage of this pipeline starts with; each stage keeps its own staleDays
Whether the pipeline has an intake stage receiving new conversations
True when the pipeline came from the network standard; only the network owner renames or removes it
object
Channels whose new conversations become leads; absent means any
Contact origins that become leads; absent means any
Sources that become leads; absent means any
Days an intake lead waits before it is flagged
When a deal is won in the source pipeline, a card is created (or the contact’s open card updated) in the stage; only management pipelines have rules
object
Sales pipeline whose won deals create a card here
Stage of this pipeline that receives the card
Up to 4 extra lines of every card of this pipeline, in order: expected_close, products, next_task, contact_tags, origin, charge, attachments or field:
Name of the won column of this board; won stays a deal status, never a stage; a new pipeline starts with Ganho
Color key of the won column, from the stage palette; a new pipeline starts with emerald
Name of the lost column of this board; lost stays a deal status, never a stage; a new pipeline starts with Perdido
Color key of the lost column, from the stage palette; a new pipeline starts with red
Whether the board shows the won column; hidden, deals are still won from the card menu
Whether the board shows the lost column; hidden, deals are still lost from the card menu
When on, a contact has at most one open deal in this pipeline; applies only to this pipeline, deals in other pipelines never block; a new management pipeline starts on
Deals still open in this pipeline; null without deals:read
Sum in centavos of the open deals; null without deals:read
object
Days in this stage after which an open deal counts as stale; new stages start with the pipeline’s staleDays
The deal only enters with an expected close date
The deal only enters with a value above zero
The deal only enters with at least one product
Custom fields of the contact, the company or the deal that must be filled to enter
Custom fields of the contact, the company or the deal that should be filled on entry: moving in without them is allowed and the move answers what is missing
Task templates marked as required at this stage
Active sequences enrolling on entry to this stage
True when the stage came from the network standard; only the network owner renames or removes it
Example
{ "groups": [ { "pipelines": [ { "type": "sales", "intakeRules": { "sources": [ "inbound_message" ] }, "stages": [ { "kind": "open" } ] } ] } ]}