v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar etapas de funil

get/stages

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima página.

idinteger

Filtrar pelo ID da etapa de funil.

hashstring

Filtrar pela hash da etapa de funil.

pipeline_idinteger

Filtrar pelo ID do funil onde consta a etapa de funil.

namestring

Filtrar pelo nome da etapa de funil.

allow_create_dealboolean

Filtrar por permissão de gerar oportunidades na etapa de funil.

allow_win_dealboolean

Filtrar por permissão de realizar a ação de ganhar oportunidades na etapa de funil.

created_at_startstring date-time

Filtrar por registros de etapas a partir da data e hora de criação informada.

created_at_endstring date-time

Filtrar por registros de etapas até a data e hora de criação informada.

updated_at_startstring date-time

Filtrar por registros de etapas a partir da data e hora de atualização informada.

updated_at_endstring date-time

Filtrar por registros de etapas até a data e hora de atualização informada.

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 123,
      "account_id": 123,
      "pipeline_id": 123,
      "name": "Recuperação",
      "description": "Playbook\nEmail de break-up\nAtividade de ligação\nMensagem Web WhatsApp\nSMS de break-up",
      "order": 6,
      "color": "rgb(103, 106, 108)",
      "days_limit": 3,
      "hash": "631864fa-83f4-4866-b641-e0ed0d6acf52",
      "allow_win_deal": true,
      "allow_create_deal": true,
      "created_at": "2025-07-21 10:32:02",
      "updated_at": "2025-07-21 10:32:02"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJ....RydWV9"
    }
  }
}