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

# Listar Agendamentos

> Retorna a lista de agendamentos da conta autenticada, com suporte a filtros.

## Requisição

`GET https://crm.wavups.com/api/v1/scheduling`

<ParamField header="Token" type="string" required>
  Seu token de autenticação.
</ParamField>

### Query Parameters

<ParamField query="startDate" type="string">
  Data de início para filtrar agendamentos pelo campo `createdAt`. Formato ISO 8601 (ex: `2025-01-01T00:00:00Z`). Utilizado em conjunto com `endDate`.
</ParamField>

<ParamField query="endDate" type="string">
  Data de fim para filtrar agendamentos. Formato ISO 8601. Utilizado em conjunto com `startDate`.
</ParamField>

<ParamField query="status" type="string">
  Filtra agendamentos pelo status. Valores possíveis: `scheduled`, `completed`, `canceled`.
</ParamField>

***

## Resposta

Retorna um array de objetos de agendamento, ordenados do mais recente para o mais antigo. Os campos `accountId` e `externalConversationId` são omitidos.

<ResponseField name="id" type="string">
  Identificador único do agendamento.
</ResponseField>

<ResponseField name="accountProductId" type="string | null">
  ID do produto vinculado ao agendamento.
</ResponseField>

<ResponseField name="title" type="string">
  Título do agendamento.
</ResponseField>

<ResponseField name="description" type="string | null">
  Descrição do agendamento.
</ResponseField>

<ResponseField name="date" type="string">
  Data e horário do agendamento (ISO 8601).
</ResponseField>

<ResponseField name="status" type="string">
  Status do agendamento. Valores: `scheduled`, `completed`, `canceled`. Padrão: `scheduled`.
</ResponseField>

<ResponseField name="createdAt" type="string">
  Data de criação (ISO 8601).
</ResponseField>

<ResponseField name="AccountExternalConversation" type="object | null">
  Dados da conversa externa vinculada ao agendamento.

  <Expandable title="Propriedades da conversa">
    <ResponseField name="leadId" type="string | null">
      ID do lead vinculado à conversa.
    </ResponseField>

    <ResponseField name="contactName" type="string">
      Nome do contato da conversa.
    </ResponseField>

    <ResponseField name="contactPhone" type="string | null">
      Telefone do contato.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Exemplos

<RequestExample>
  ```bash GET /api/v1/scheduling theme={null}
  curl --request GET \
    --url 'https://crm.wavups.com/api/v1/scheduling?status=scheduled' \
    --header 'Token: SEU_TOKEN_DE_API'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": "sch_001",
      "accountProductId": "prod_001",
      "title": "Consulta Inicial",
      "description": "Primeira consulta do cliente",
      "date": "2025-07-10T14:00:00.000Z",
      "status": "scheduled",
      "createdAt": "2025-06-15T10:00:00.000Z",
      "AccountExternalConversation": {
        "leadId": "lead_xyz",
        "contactName": "João Silva",
        "contactPhone": "11999998888"
      }
    }
  ]
  ```

  ```json 500 theme={null}
  {
    "error": "Error to get schedulings"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /scheduling
openapi: 3.0.3
info:
  title: WavUps CRM API
  description: >-
    API pública da plataforma WavUps CRM — gerencie leads, produtos, categorias,
    atendimentos, agendamentos, conversas e pipelines de CRM.
  version: 1.0.0
servers:
  - url: https://crm.wavups.com/api/v1
    description: Servidor de produção
security:
  - Token: []
paths:
  /scheduling:
    get:
      tags:
        - Agendamentos
      summary: Listar Agendamentos
      description: >-
        Retorna a lista de agendamentos da conta autenticada, com suporte a
        filtros.
      operationId: listSchedulings
      parameters:
        - name: startDate
          in: query
          description: Data de início (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: Data de fim (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: leadId
          in: query
          description: Filtra agendamentos pelo ID do lead.
          schema:
            type: string
        - name: productId
          in: query
          description: Filtra agendamentos pelo ID do produto.
          schema:
            type: string
      responses:
        '200':
          description: Lista de agendamentos retornada com sucesso.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Scheduling'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    Scheduling:
      type: object
      properties:
        id:
          type: string
        leadId:
          type: string
          nullable: true
        productId:
          type: string
          nullable: true
        scheduledAt:
          type: string
          format: date-time
          nullable: true
        status:
          type: string
        description:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
    ErrorMessage:
      type: object
      properties:
        error:
          type: string
          example: Recurso não encontrado.
  responses:
    Error500:
      description: Erro interno no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Token
      description: Token de autenticacao gerado na plataforma WavUps CRM.

````