> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziala.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar etapas

> Lista todas as etapas de todos os funis da conta, numa página só. `next_cursor`, `has_more` e `sync_watermark` existem só para manter o formato comum das listas.



## OpenAPI

````yaml https://api.ziala.com.br/v1/openapi.json get /v1/pipeline_stages
openapi: 3.0.0
info:
  title: API de dados da Ziala
  description: >-
    Leitura dos dados da sua conta (contatos, campos, conversas com origem de
    anúncio, mudanças de etapa e exclusões) para painéis e plataformas de dados.
  version: '1'
  contact:
    name: Suporte Ziala
    url: https://ziala.com.br
    email: contato@ziala.com.br
servers:
  - url: https://api.ziala.com.br
security: []
tags:
  - name: Conta
    description: A conta e os limites da chave.
  - name: Contatos
    description: Contatos e os valores dos campos personalizados.
  - name: Conversas
    description: Conversas, com origem e métricas.
  - name: Funis
    description: Etapas dos funis e o histórico de mudanças de etapa.
  - name: Campos
    description: Definições dos campos personalizados.
  - name: Exclusões
    description: Registros apagados, para replicar a exclusão.
paths:
  /v1/pipeline_stages:
    get:
      tags:
        - Funis
      summary: Listar etapas
      description: >-
        Lista todas as etapas de todos os funis da conta, numa página só.
        `next_cursor`, `has_more` e `sync_watermark` existem só para manter o
        formato comum das listas.
      operationId: listPipelineStages
      parameters: []
      responses:
        '200':
          headers:
            RateLimit-Limit:
              description: Requisições permitidas por minuto para a chave.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requisições restantes no minuto.
              schema:
                type: integer
            RateLimit-Reset:
              description: Segundos até o minuto reiniciar.
              schema:
                type: integer
          description: Todas as etapas.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - next_cursor
                  - has_more
                  - sync_watermark
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - pipeline_id
                        - pipeline_name
                        - key
                        - label
                        - sort_order
                        - is_won
                        - is_lost
                        - is_terminal
                      properties:
                        id:
                          type: string
                          nullable: false
                          description: Identificador único do registro.
                          example: 3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10
                        pipeline_id:
                          type: string
                          nullable: false
                          description: Identificador do funil.
                          example: e2a9f4c1-7b3d-4f6e-a1c8-9d0b5e2f7a33
                        pipeline_name:
                          type: string
                          nullable: false
                          description: Nome do funil.
                          example: Vendas
                        key:
                          type: string
                          nullable: false
                          description: >-
                            Chave estável, usada para referenciar o registro em
                            outros objetos.
                          example: qualificando
                        label:
                          type: string
                          nullable: false
                          description: Nome exibido no painel.
                          example: Qualificando
                        sort_order:
                          type: integer
                          nullable: false
                          description: Posição da etapa no funil, em ordem crescente.
                          example: 2
                        is_won:
                          type: boolean
                          description: '`true` se a etapa conta como ganho.'
                          example: false
                        is_lost:
                          type: boolean
                          description: '`true` se a etapa conta como perda.'
                          example: false
                        is_terminal:
                          type: boolean
                          description: '`true` se a etapa encerra o funil.'
                          example: false
                  next_cursor:
                    type: string
                    nullable: true
                    example: >-
                      eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9
                    description: >-
                      Cursor da próxima página. Sempre `null`: o endpoint
                      devolve tudo numa página.
                  has_more:
                    type: boolean
                    example: false
                    description: >-
                      `true` se há mais páginas. Sempre `false`: o endpoint
                      devolve tudo numa página.
                  sync_watermark:
                    type: string
                    format: date-time
                    example: '2026-10-13T14:29:00.000Z'
                    description: >-
                      Instante até o qual esta leitura está completa, igual em
                      todas as páginas. Envie como `updated_since` na próxima
                      sincronização.
        '401':
          description: Chave ausente, inválida ou revogada.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '403':
          description: API de dados desligada na conta, ou plano sem acesso.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '429':
          description: >-
            Limite de requisições atingido (por minuto, por dia ou simultâneas).
            Aguarde o `Retry-After`.
          headers:
            Retry-After:
              description: Segundos a aguardar antes de repetir a requisição.
              schema:
                type: integer
            RateLimit-Limit:
              description: Requisições permitidas por minuto para a chave.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requisições restantes no minuto.
              schema:
                type: integer
            RateLimit-Reset:
              description: Segundos até o minuto reiniciar.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '500':
          description: Erro inesperado. Repita com espera crescente.
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
        '503':
          description: Serviço temporariamente indisponível. Aguarde o `Retry-After`.
          headers:
            Retry-After:
              description: Segundos a aguardar antes de repetir a requisição.
              schema:
                type: integer
            RateLimit-Limit:
              description: Requisições permitidas por minuto para a chave.
              schema:
                type: integer
            RateLimit-Remaining:
              description: Requisições restantes no minuto.
              schema:
                type: integer
            RateLimit-Reset:
              description: Segundos até o minuto reiniciar.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - title
                  - status
                  - detail
                  - request_id
                properties:
                  type:
                    type: string
                    example: about:blank
                    description: Sempre `about:blank`.
                  title:
                    type: string
                    example: Requisição inválida
                    description: Resumo do erro, fixo por status.
                  status:
                    type: integer
                    example: 400
                    description: Status HTTP.
                  detail:
                    type: string
                    example: limit deve ser um número inteiro de 1 a 200.
                    description: Explicação desta ocorrência.
                  request_id:
                    type: string
                    example: req-3f2a
                    description: Identificador da requisição, para o suporte.
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: zk_live_…
      type: http
      description: Chave da API da conta, no formato `zk_live_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.