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

# List Appointments

> Returns cursor-paginated appointments backed by the Conduit booking service.



## OpenAPI

````yaml GET /v1/appointments
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      V2 chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to V2 chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inboxTypeId` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/appointments:
    get:
      tags:
        - appointments
      summary: List appointments
      description: >-
        Returns cursor-paginated appointments backed by the Conduit booking
        service. v1 exposes allocation + `external_id` context only; full
        appointment details (scheduled time, assigned agent, location) are
        retrievable from the booking service using `external_id`.
      operationId: listAppointments
      parameters:
        - schema:
            type: string
            description: Workspace to query.
            example: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
          required: true
          name: workspace_id
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: Page size. Defaults to 20. Max 100.
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: Pagination cursor returned as `next_cursor` on the previous page.
          required: false
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            description: >-
              Sort direction over scheduled start time. Defaults to `desc` (most
              recently scheduled first).
          required: false
          name: order
          in: query
        - schema:
            type: string
            enum:
              - awaiting_response
              - awaiting_confirmation
              - confirmed
              - cancelled
              - completed
              - no_show
              - rescheduled
            description: >-
              Filter by appointment status. Use `completed`, `no_show`,
              `cancelled`, or `rescheduled` to compute booking efficacy rates.
          required: false
          name: status
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Only return appointments scheduled at or after this ISO 8601
              timestamp.
            example: '2026-04-01T00:00:00.000Z'
          required: false
          name: start_after
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Only return appointments scheduled strictly before this ISO 8601
              timestamp.
            example: '2026-05-01T00:00:00.000Z'
          required: false
          name: start_before
          in: query
      responses:
        '200':
          description: Appointments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Conduit appointment id.
                        workspace_id:
                          type: string
                        contact_id:
                          type: string
                          nullable: true
                          description: >-
                            Contact associated with this appointment. `null` if
                            the appointment is not yet linked to a contact.
                        external_id:
                          type: string
                          nullable: true
                          description: >-
                            Upstream booking service id (typically prefixed
                            `bk_`). `null` if the appointment was created
                            outside the booking service sync.
                        status:
                          type: string
                          enum:
                            - awaiting_response
                            - awaiting_confirmation
                            - confirmed
                            - cancelled
                            - completed
                            - no_show
                            - rescheduled
                          description: >-
                            Appointment lifecycle status. Use `completed`,
                            `no_show`, `cancelled`, and `rescheduled` to compute
                            booking efficacy rates.
                        start_at:
                          type: string
                          nullable: true
                          description: >-
                            ISO 8601 scheduled start time. `null` if the
                            appointment is a scheduling link that has not been
                            claimed.
                        end_at:
                          type: string
                          nullable: true
                          description: ISO 8601 scheduled end time.
                        duration_ms:
                          type: number
                          nullable: true
                          description: >-
                            Scheduled duration in milliseconds, derived from
                            `end_at - start_at`. `null` if either boundary is
                            missing.
                        origin:
                          type: string
                          nullable: true
                          description: >-
                            Where the booking originated (e.g. `call`, `text`,
                            `direct`).
                        notes:
                          type: string
                          nullable: true
                          description: Operator-entered notes about the appointment.
                        generated_context:
                          type: string
                          nullable: true
                          description: >-
                            AI-generated summary of the conversation context
                            leading to the booking.
                        short_link_id:
                          type: string
                          description: >-
                            Identifier of the scheduling short link used to
                            create this appointment.
                        strength_indicator:
                          type: number
                          nullable: true
                          description: >-
                            Optional 0..1 confidence score of booking quality
                            (provided by the booking service).
                        booking_info:
                          type: object
                          properties:
                            name:
                              type: string
                              nullable: true
                            email:
                              type: string
                              nullable: true
                            phone:
                              type: string
                              nullable: true
                            notes:
                              type: string
                              nullable: true
                          required:
                            - name
                            - email
                            - phone
                            - notes
                          description: Contact details captured at the time of booking.
                        references:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                nullable: true
                              type:
                                type: string
                                enum:
                                  - property
                                  - unit
                                  - unknown
                              value:
                                type: string
                            required:
                              - id
                              - type
                              - value
                          description: >-
                            External entities the appointment is scoped to (e.g.
                            a property or unit).
                        last_synced_at:
                          type: string
                          nullable: true
                          description: >-
                            ISO 8601 of the last sync from the upstream booking
                            service.
                        created_at:
                          type: string
                      required:
                        - id
                        - workspace_id
                        - contact_id
                        - external_id
                        - status
                        - start_at
                        - end_at
                        - duration_ms
                        - origin
                        - notes
                        - generated_context
                        - short_link_id
                        - strength_indicator
                        - booking_info
                        - references
                        - last_synced_at
                        - created_at
                      description: >-
                        A scheduled appointment, including status, start/end
                        times, notes, and the contact details captured at
                        booking time.
                  next_cursor:
                    type: string
                    nullable: true
                  has_more:
                    type: boolean
                required:
                  - data
                  - next_cursor
                  - has_more
                description: Cursor-paginated appointments response.
                example:
                  data:
                    - id: ar77c0dy0mgdpzmqz6tesry8w184002s
                      workspace_id: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
                      contact_id: ph77c0dy0mgdpzmqz6tesry8w184002s
                      external_id: bk_vcNpA4g3iJWvlkY1
                      status: confirmed
                      start_at: '2026-04-21T13:30:00.000Z'
                      end_at: '2026-04-21T13:45:00.000Z'
                      duration_ms: 900000
                      origin: direct
                      notes: Tour of the property, coming from Airbnb inquiry.
                      generated_context: Guest asked about check-in flexibility.
                      short_link_id: sl_8m3qxv2
                      strength_indicator: 0.82
                      booking_info:
                        name: Taylor Reid
                        email: taylor.reid@example.com
                        phone: '+14155550123'
                        notes: null
                      references:
                        - id: listing_456
                          type: unit
                          value: Unit 4B
                      last_synced_at: '2026-04-18T16:12:05.000Z'
                      created_at: '2026-04-18T16:12:00.000Z'
                  next_cursor: page-token
                  has_more: true
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````