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

# Listar campanhas

> Consulte informações da sua conta. Requer acesso ao Disparador.



## OpenAPI

````yaml /openapi.json get /v1/sender/campaigns
openapi: 3.1.0
info:
  title: Readyzap API
  version: 1.0.0
  description: Consultas autenticadas de conta, chips e campanhas.
servers:
  - url: https://db.readyzap.com.br/functions/v1/api
security:
  - ReadyzapKey: []
tags:
  - name: Conta
  - name: Aquecedor
  - name: Disparador
paths:
  /v1/sender/campaigns:
    get:
      tags:
        - Disparador
      summary: Listar campanhas
      description: Consulte informações da sua conta. Requer acesso ao Disparador.
      operationId: list_sender_campaigns
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Consulta concluída. Exemplo fictício e resumido.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Campanha'
                  limit:
                    type: integer
                  offset:
                    type: integer
                required:
                  - data
                  - limit
                  - offset
              example:
                data:
                  - id: 22222222-2222-2222-2222-222222222222
                    name: Novidades da loja
                    status: paused
                    total_contacts: 5
                    sent_count: 3
                    failed_count: 1
                    unknown_count: 1
                limit: 50
                offset: 0
        '401':
          $ref: '#/components/responses/Erro401'
        '403':
          $ref: '#/components/responses/Erro403'
        '429':
          $ref: '#/components/responses/Erro429'
        '503':
          $ref: '#/components/responses/Erro503'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Quantidade de itens na página.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Offset:
      name: offset
      in: query
      description: Quantidade de itens a pular.
      schema:
        type: integer
        minimum: 0
        maximum: 100000
        default: 0
  schemas:
    Campanha:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
            - string
            - 'null'
        status:
          type:
            - string
            - 'null'
        total_contacts:
          type:
            - integer
            - 'null'
        sent_count:
          type:
            - integer
            - 'null'
        failed_count:
          type:
            - integer
            - 'null'
        unknown_count:
          type:
            - integer
            - 'null'
        scheduled_at:
          type:
            - string
            - 'null'
          format: date-time
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
    Erro:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  responses:
    Erro401:
      description: Chave ausente, inválida ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error:
              code: invalid_key
              message: Chave inválida ou revogada.
    Erro403:
      description: Acesso à API indisponível ou módulo exigido não habilitado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error:
              code: plan_not_allowed
              message: A API está disponível nos planos Pro e Business ativos.
    Erro429:
      description: Limite de requisições atingido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error:
              code: rate_limited
              message: >-
                Limite de requisições por minuto atingido. Tente novamente no
                próximo minuto.
      headers:
        Retry-After:
          description: Tempo de espera em segundos.
          schema:
            type: integer
          example: 60
    Erro503:
      description: Serviço temporariamente indisponível
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error:
              code: unavailable
              message: Serviço temporariamente indisponível.
  securitySchemes:
    ReadyzapKey:
      type: http
      scheme: bearer
      description: Chave criada em Integrações → Readyzap API.

````

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