curl https://crm.vistum.com.br/api/v1/pipelines \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"pipelines": [
{
"id": "pipe_vendas01",
"name": "Vendas",
"order": 0,
"stages": [
{ "id": "stage_qualif01", "name": "Qualificação", "order": 0 },
{ "id": "stage_propost02", "name": "Proposta", "order": 1 },
{ "id": "stage_fechado03", "name": "Fechado", "order": 2 }
],
"customFields": [
{ "id": "cf_cidade01", "key": "cidade", "label": "Cidade", "type": "text" },
{ "id": "cf_score02", "key": "score", "label": "Score", "type": "number" }
]
}
]
}
Pipelines
Listar Pipelines
Lista os pipelines do workspace com suas etapas e campos personalizados. Use para descobrir os IDs e nomes que você vai passar em pipeline e stage ao criar leads.
GET
/
api
/
v1
/
pipelines
curl https://crm.vistum.com.br/api/v1/pipelines \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"pipelines": [
{
"id": "pipe_vendas01",
"name": "Vendas",
"order": 0,
"stages": [
{ "id": "stage_qualif01", "name": "Qualificação", "order": 0 },
{ "id": "stage_propost02", "name": "Proposta", "order": 1 },
{ "id": "stage_fechado03", "name": "Fechado", "order": 2 }
],
"customFields": [
{ "id": "cf_cidade01", "key": "cidade", "label": "Cidade", "type": "text" },
{ "id": "cf_score02", "key": "score", "label": "Score", "type": "number" }
]
}
]
}
Autenticação
string
required
Bearer vg_live_<sua_chave> — API Key com escopo leads:write ou pipelines:read.A mesma chave usada para Criar Lead já funciona aqui: o escopo leads:write também autoriza a leitura de pipelines.Para que serve
Ao criar um lead, os campospipeline e stage aceitam nome ou ID. Este endpoint devolve exatamente esses valores para o seu workspace, evitando erros de digitação no nome e permitindo referenciar pipelines/etapas por ID (mais estável que o nome).
Também retorna os campos personalizados definidos em cada pipeline, para você saber quais chaves preencher em customFields.
Resposta de sucesso
object[]
Lista de pipelines do workspace, ordenada pela mesma ordem exibida no CRM.
Show campos do pipeline
Show campos do pipeline
string
ID único do pipeline. Use em
pipeline ao criar um lead.string
Nome do pipeline.
number
Posição do pipeline na ordenação do CRM.
object[]
Erros
| Código | Causa |
|---|---|
401 Unauthorized | Chave inválida, ausente ou expirada |
403 Forbidden | Chave válida, mas sem o escopo leads:write nem pipelines:read |
429 Too Many Requests | Limite de 120 requisições por minuto (por IP) excedido |
500 Internal Server Error | Falha ao consultar os pipelines |
curl https://crm.vistum.com.br/api/v1/pipelines \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"pipelines": [
{
"id": "pipe_vendas01",
"name": "Vendas",
"order": 0,
"stages": [
{ "id": "stage_qualif01", "name": "Qualificação", "order": 0 },
{ "id": "stage_propost02", "name": "Proposta", "order": 1 },
{ "id": "stage_fechado03", "name": "Fechado", "order": 2 }
],
"customFields": [
{ "id": "cf_cidade01", "key": "cidade", "label": "Cidade", "type": "text" },
{ "id": "cf_score02", "key": "score", "label": "Score", "type": "number" }
]
}
]
}