> ## Documentation Index
> Fetch the complete documentation index at: https://developers.huechat.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List synced appointments for reconciliation

> Requires a REST API key with appointments:sync on an approved account. Returns every booking with an external_id that starts in [start, end), at most 31 days, ordered by start time, with a cursor for the next page.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/accounts/{accountId}/appointments/sync
openapi: 3.0.3
info:
  contact:
    name: HueChat support
    email: support@huechat.ai
    url: https://huechat.ai/contact
  description: >-
    Account-scoped REST API for HueChat: conversations, messages, contacts,
    Customer CDP, Sales CRM, forms, appointments, inboxes, teams, agents, AI
    agents and knowledge, WhatsApp templates and broadcasts, workflows and chat
    menus. Authenticate with account-scoped API keys; every route is scoped to
    your own account.
  license:
    name: Proprietary
    url: https://huechat.ai/terms
  termsOfService: https://huechat.ai/terms
  title: HueChat API
  version: 2.0.0
servers:
  - url: https://app.huechat.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: The human agents on your account and their availability.
  - name: AI Agents
    description: >-
      Assistants you build to answer customers on their own: persona, language,
      guardrails, tools and a knowledge base, published to inboxes, replying in
      Arabic or English until they hand off to a human. Create, publish, test,
      monitor quality and roll back versions.
  - name: Broadcasts
    description: >-
      Send a WhatsApp template to a list of contacts from a CSV or saved
      audience, with scheduling, pause and resume, and delivery reports.
  - name: Chat Menus
    description: >-
      Numbered or button-driven menus a customer sees at the start of a
      conversation.
  - name: Contacts
    description: >-
      The people your team talks to: phone, email, name, custom attributes,
      labels and notes. One contact can have conversations on several channels.
  - name: Conversations
    description: >-
      A conversation is one thread between a contact and your team on one
      channel, with status, assignee, team, labels, priority and custom
      attributes. List, filter, search, assign, resolve and annotate them.
  - name: Forms
    description: >-
      Form management, assets, delivery, respondent sessions, submissions,
      scheduling, reports and AI-assisted authoring in one group.
  - name: Inboxes
    description: >-
      Connected channels: a WhatsApp Business number, an Instagram or Messenger
      page, an email address or a website live-chat widget. Inboxes decide where
      a conversation comes from and who can see it.
  - name: Knowledge
    description: >-
      Documents, web pages and text that ground an AI agent's answers. Upload,
      point at a URL or paste text; HueChat indexes it and the agent cites it.
  - name: Messages
    description: >-
      Everything said inside a conversation: text, attachments, WhatsApp
      templates and interactive replies. Sending through the API delivers on the
      conversation's channel and shows in the inbox like any agent reply.
  - name: Sales CRM
    description: >-
      The full tenant-scoped Sales workspace: Leads, Companies, Deals, tasks,
      products, price books, quotes, payments, forecasts, reports and settings.
  - name: Teams
    description: Groups of agents used for assignment and reporting.
  - name: Templates
    description: >-
      Pre-approved WhatsApp message formats required by Meta for
      business-initiated messages. Create, sync from Meta, AI-generate,
      test-send and read analytics.
  - name: Workflows
    description: >-
      Automation flows built from triggers and steps: route, tag, reply, wait,
      hand off. Create, publish, version and toggle.
paths:
  /api/v2/accounts/{accountId}/appointments/sync:
    get:
      tags:
        - Appointments
      summary: List synced appointments for reconciliation
      description: >-
        Requires a REST API key with appointments:sync on an approved account.
        Returns every booking with an external_id that starts in [start, end),
        at most 31 days, ordered by start time, with a cursor for the next page.
      operationId: get_api_v2_accounts_accountId_appointments_sync
      parameters:
        - name: accountId
          in: path
          required: true
          description: HueChat account ID
          schema:
            type: integer
            description: HueChat account ID
        - name: start
          in: query
          required: true
          description: Window start (RFC3339)
          schema:
            type: string
            description: Window start (RFC3339)
        - name: end
          in: query
          required: true
          description: Window end (RFC3339)
          schema:
            type: string
            description: Window end (RFC3339)
        - name: limit
          in: query
          required: false
          description: Page size (1-1000)
          schema:
            type: integer
            default: 500
            description: Page size (1-1000)
        - name: cursor
          in: query
          required: false
          description: next_cursor from the previous page
          schema:
            type: string
            description: next_cursor from the previous page
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentSyncListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.AppointmentAPIError'
      security:
        - bearerAuth: []
components:
  schemas:
    huechat.AppointmentSyncListResponse:
      type: object
      properties:
        appointments:
          type: array
          items:
            $ref: '#/components/schemas/huechat.AppointmentSyncListItem'
        next_cursor:
          type: string
    huechat.AppointmentAPIError:
      type: object
      properties:
        error:
          type: string
        limit:
          type: string
    huechat.AppointmentSyncListItem:
      type: object
      properties:
        appointment_id:
          type: string
        ends_at:
          type: string
          format: date-time
        external_id:
          type: string
        resource_id:
          type: string
        service_id:
          type: string
        source:
          type: string
        source_updated_at:
          type: string
          format: date-time
        starts_at:
          type: string
          format: date-time
        status:
          type: string
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your personal access token where supported, or a scoped API key (`hc_…`)
        created inside HueChat at Account → Developer API. Send it as
        `Authorization: Bearer <token>`.

````