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

# Lista horários

> Lista os horários livres para a videoconferência.

> [!NOTE]
>
> Consultar não reserva o horário. Para reservar, envie `date` e `time` ao [criar o protocolo](https://docs.certificados.zapsign.com.br/api-reference/protocolos/cria-protocolo.md) ou ao [agendar](https://docs.certificados.zapsign.com.br/api-reference/agendamento/agenda-videoconferencia.md).

> [!NOTE]
>
> Veja também: [Erros](https://docs.certificados.zapsign.com.br/erros.md)


## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partners/appointment-slots
openapi: 3.1.0
info:
  title: Certificados ZapSign Partner API v2
  version: 2.0.0
  description: >-
    API REST para parceiros criarem e acompanharem protocolos de certificado
    digital e-CPF e e-CNPJ (A1 e A3 em nuvem), emitidos por videoconferência.
  contact:
    name: Suporte Certificados ZapSign
    url: https://wa.me/5511952135263
servers:
  - url: https://certificados.zapsign.com.br
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Protocolos
    description: Criação, consulta, listagem e cancelamento de protocolos.
  - name: Verificação
    description: Verificação opcional do titular antes de criar o protocolo.
  - name: Agendamento
    description: Horários livres e agendamento da videoconferência.
  - name: Saldo e catálogo
    description: Saldo atual e certificados disponíveis para o parceiro.
paths:
  /api/v2/partners/appointment-slots:
    get:
      tags:
        - Agendamento
      summary: Lista horários
      description: Lista os horários livres para a videoconferência.
      operationId: listAppointmentSlots
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            Primeiro dia da consulta. Formato `AAAA-MM-DD`. Padrão: hoje, em
            Brasília. Vai de hoje até `bookable_until`.
          schema:
            type: string
            format: date
          example: '2026-10-22'
        - name: days
          in: query
          required: false
          description: >-
            Quantidade de dias seguidos, a partir de `from`. Inclui fins de
            semana.
          schema:
            type: integer
            minimum: 1
            maximum: 7
            default: 7
          example: 5
      responses:
        '200':
          description: Dias consultados, com os horários livres de cada um.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlotList'
              examples:
                Intervalo de dias escolhido:
                  summary: Intervalo de dias escolhido
                  value:
                    data:
                      - date: '2026-10-22'
                        times:
                          - '10:00'
                          - '11:30'
                      - date: '2026-10-23'
                        times: []
                      - date: '2026-10-24'
                        times: []
                      - date: '2026-10-25'
                        times: []
                      - date: '2026-10-26'
                        times:
                          - '08:00'
                    has_more: true
                    bookable_until: '2026-11-19'
                    timezone: America/Sao_Paulo
                    object: list
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -G
            'https://certificados.zapsign.com.br/api/v2/partners/appointment-slots'
            \
              -H 'Authorization: Bearer czk_live_SUA_CHAVE' \
              --data-urlencode 'days=5'
        - lang: javascript
          label: Node.js (fetch)
          source: |-
            const params = new URLSearchParams({ days: '5' });
            const res = await fetch(
              `https://certificados.zapsign.com.br/api/v2/partners/appointment-slots?${params}`,
              {
                headers: { Authorization: 'Bearer czk_live_SUA_CHAVE' },
              },
            );
            const horarios = await res.json();
            // Cada item de `data` traz a `date` e os `times` livres.
        - lang: python
          label: Python (requests)
          source: |-
            import requests

            res = requests.get(
                'https://certificados.zapsign.com.br/api/v2/partners/appointment-slots',
                headers={'Authorization': 'Bearer czk_live_SUA_CHAVE'},
                params={'days': 5},
            )
            horarios = res.json()
            # Cada item de data traz a date e os times livres.
components:
  headers:
    XRequestId:
      description: Identificador da chamada. Informe-o ao suporte se precisar de ajuda.
      schema:
        type: string
        example: 01K7Q4A1B2C3D4E5F6G7H8J9KM
  schemas:
    SlotList:
      type: object
      required:
        - object
        - has_more
        - timezone
        - bookable_until
        - data
      properties:
        data:
          type: array
          description: >-
            Um item por dia consultado, em ordem de data. Inclui dias sem
            horário livre. Pode ter menos itens que `days` perto de
            `bookable_until`.
          items:
            $ref: '#/components/schemas/SlotDay'
        has_more:
          type: boolean
          description: >-
            `true` se há dias agendáveis depois do último dia de `data`. Peça os
            próximos com `from`.
          example: true
        bookable_until:
          type: string
          description: Último dia agendável. Formato `AAAA-MM-DD`.
          format: date
          example: '2026-11-19'
        timezone:
          type: string
          description: Fuso horário de `date` e `times`, hoje `America/Sao_Paulo`.
          example: America/Sao_Paulo
        object:
          type: string
          const: list
          description: Sempre `list`.
    SlotDay:
      type: object
      description: Horários livres de um dia.
      required:
        - date
        - times
      properties:
        date:
          type: string
          description: Dia consultado. Formato `AAAA-MM-DD`.
          format: date
          example: '2026-10-22'
        times:
          type: array
          description: >-
            Horários livres do dia, de Brasília. Formato `HH:MM`. Vazio em fins
            de semana, sem horário livre ou se a consulta do dia falhou.
          items:
            type: string
            pattern: ^(?:[01]\d|2[0-3]):[0-5]\d$
            example: '10:00'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: czk_live_*
      description: >-
        API key criada no [portal do
        parceiro](https://certificados.zapsign.com.br/reseller/api-keys).

````

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