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

# getAgendamentos

> <h2>Obtém os agendamentos do usuário especificado.</h2>

<h6 class="label label-success">Response:</h6>
<table class="table table-hover"> <tbody><tr><td>agendamentos</td><td> Estrutura de Agendamentos: <table class="table table-hover"> <tbody><tr><td>id</td><td>Id do agendamento</td></tr> <tr><td>data</td><td>Data e hora do agendamento</td></tr> <tr><td>nome</td><td>Nome do Prospect</td></tr> <tr><td>lote</td><td>Descrição do lote</td></tr> <tr><td>tipo</td><td>Tipo de agendamento:<br /> <ul> <li> G = Genérico, onde qualquer agente poderá atender</li> <li> E = Específico, onde somente este agente poderá atender</li> </ul> </td></tr> <tr><td>fila</td><td>Descrição da fila</td></tr> <tr><td>usuario</td><td>Login do agente</td></tr> </tbody></table> </td></tr> </tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getAgendamentos
openapi: 3.0.0
info:
  title: IPBoX Api Documentation v1.1
  description: >-
    Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
    comandos são executados com chamadas POST e com respostas em formato JSON.
  version: 1.0.0
servers:
  - url: https://{baseUrl}
    description: Dominio (e porta, se houver) do servidor IPBoX do cliente
    variables:
      baseUrl:
        default: cliente.ipboxcloud.com.br:9052
        description: >-
          Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
          servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
          cliente.ipboxcloud.com.br:9052)
security:
  - ApiToken: []
tags:
  - name: Agente
  - name: Ligações
  - name: Prospects
  - name: Agendamentos
  - name: Listas
  - name: Filas
  - name: Lotes
  - name: Relatórios
  - name: Outros
  - name: Times
  - name: Blacklist
  - name: Áudios
  - name: URAs
paths:
  /ipbox/api/getAgendamentos:
    post:
      tags:
        - Agendamentos
      summary: getAgendamentos
      description: >-
        <h2>Obtém os agendamentos do usuário especificado.</h2>


        <h6 class="label label-success">Response:</h6>

        <table class="table table-hover"> <tbody><tr><td>agendamentos</td><td>
        Estrutura de Agendamentos: <table class="table table-hover">
        <tbody><tr><td>id</td><td>Id do agendamento</td></tr>
        <tr><td>data</td><td>Data e hora do agendamento</td></tr>
        <tr><td>nome</td><td>Nome do Prospect</td></tr>
        <tr><td>lote</td><td>Descrição do lote</td></tr>
        <tr><td>tipo</td><td>Tipo de agendamento:<br /> <ul> <li> G = Genérico,
        onde qualquer agente poderá atender</li> <li> E = Específico, onde
        somente este agente poderá atender</li> </ul> </td></tr>
        <tr><td>fila</td><td>Descrição da fila</td></tr>
        <tr><td>usuario</td><td>Login do agente</td></tr> </tbody></table>
        </td></tr> </tbody></table>
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                usuario:
                  type: string
                  description: 'Login do usuario. Ex.: samara.'
                  example: usuario
                tipo:
                  type: string
                  description: >-
                    [Opcional] (E = Específico, G = Genérico). Se nao informado,
                    retorna todos os tipos.
                  example: tipo
                de:
                  type: string
                  description: >-
                    [Opcional porém obrigatório se {{ate}} for informado]. Data
                    inicial do periodo no formato AAAA-MM-DD HH:MM:SS.
                  example: de
                ate:
                  type: string
                  description: >-
                    [Opcional porém obrigatório se {{de}} for informado]. Data
                    final do periodo no formato AAAA-MM-DD HH:MM:SS.
                  example: ate
                nome:
                  type: string
                  description: '[Opcional] Filtrar agendamentos pelo nome do prospect'
                  example: nome
              required:
                - usuario
                - tipo
                - de
                - ate
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
        `Bearer ` / `Basic `.

````