Conduyt Appointments API

openapi: 3.2.0
info:
  title: Conduyt Appointments API
  version: 1.0.0
  description: 'The Conduyt CRM API provides programmatic access to your CRM data including

    contacts, companies, deals, pipelines, tasks, notes, automations, invoices,

    email sequences, and more.


    ## Authentication


    All authenticated endpoints require a Bearer token (API key) in the

    `Authorization` header:


    ```

    Authorization: Bearer cdy_

    ```


    API keys are generated in **Settings > API Keys** within the Conduyt

    dashboard. Keys use the `cdy_` prefix and are hashed with bcrypt on

    creation — the full key is shown exactly once at creation time.


    Session cookie authentication (`conduyt_session`) is also supported for

    browser-based clients but is not recommended for integrations.


    ## Rate Limiting


    API keys enforce a per-key rate limit. New keys default to 100 requests per

    minute and can be configured at creation time or with PATCH `/api-keys/{id}`.

    Some public and provider-facing endpoints also enforce stricter per-IP or

    per-account limits. When exceeded, the API returns `429 Too Many Requests`

    with a `Retry-After` header indicating seconds until the next allowed

    request.


    | Endpoint Group | Limit |

    |---------------------|---------------------|

    | API keys | Default 100 / min per key |

    | Login/reset | 5 / min per IP |

    | Registration | 3 / hour per IP |

    | Contact/Deal create | 30 / min per IP |

    | Inbound messages | 120 / min per account/IP |


    ## Pagination


    List endpoints support cursor-based pagination via query parameters:


    - `page` — Page number (default: 1)

    - `per_page` — Items per page (default: 50, max: 200)

    - `limit` — Accepted as an alias of `per_page` on `GET /contacts`; if both are

    sent they must carry the same value.


    A page size above the maximum, a non-integer, a value below 1, or a

    pagination key repeated with different values is rejected with `400`

    (the message names the parameter and the rule); nothing is silently

    clamped or ignored.


    Responses include a `meta` object: `{ page, per_page, total }`.


    An operation that documents its own pagination rules follows those instead.

    `GET /sms-providers/options` pages with an opaque `cursor` and a `limit`

    that is capped at 50 rather than rejected; its responses carry

    `meta: { nextCursor, truncated }`.


    ## Response Format


    All successful responses wrap data in a `data` envelope:

    ```json

    { "data": { ... } }

    ```


    Error responses use:

    ```json

    { "error": "Human-readable error message" }

    ```


    ## Multi-Tenancy


    Conduyt is multi-tenant. All data is scoped to the authenticated user''s

    current account. API keys are bound to a specific account at creation time.


    ## Webhook Events


    Outbound webhooks fire on events including:

    `contact.created`, `contact.updated`, `contact.deleted`,

    `deal.created`, `deal.updated`, `deal.won`, `deal.lost`,

    `task.created`, `task.completed`, `note.created`,

    `appointment.created`, `appointment.updated`,

    `form.submitted`, `invoice.paid`


    Payloads are signed with HMAC-SHA256 using the webhook''s secret. Retry

    schedule: 1m, 5m, 30m, 2h, 12h, 72h (7 total attempts including the initial delivery).'
  contact:
    name: Conduyt Support
    url: https://conduyt.app
    email: support@conduyt.app
  license:
    name: Proprietary
    url: https://conduyt.app/terms
servers:
- url: https://conduyt.app/api/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: Appointments
  description: Appointment scheduling
paths:
  /appointments:
    get:
      operationId: listAppointments
      summary: List all appointments
      tags:
      - Appointments
      parameters:
      - name: assigned_to
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: booking_page_id
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: calendar_id
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: contact_id
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: from
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: page
        in: query
        required: false
        description: Page number
        schema:
          type: integer
          default: 1
          minimum: 1
        x-default-provenance: handler_literal
      - name: per_page
        in: query
        required: false
        description: Items per page (max 200)
        schema:
          type: integer
          default: 50
          minimum: 1
          maximum: 200
        x-default-provenance: handler_literal
      - name: status
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: to
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      responses:
        '200':
          description: Paginated appointments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data: {}
                      meta: {}
                    required:
                    - data
                    - meta
                required:
                - data
    post:
      operationId: createAppointment
      summary: Create an appointment
      tags:
      - Appointments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              - startTime
              - endTime
              properties:
                title:
                  type: string
                description:
                  type: string
                startTime:
                  type: string
                  format: date-time
                endTime:
                  type: string
                  format: date-time
                location:
                  type: string
                status:
                  type: string
                  enum:
                  - scheduled
                  - confirmed
                  - completed
                  - cancelled
                  - no_show
                  default: scheduled
                contactId:
                  type: string
                  format: uuid
                  description: A contact of your account; when no contact has this id it is looked up as a deal (card) of your account, and the appointment is booked for that deal (see dealId).
                dealId:
                  type: string
                  format: uuid
                  description: The deal (card) this appointment is for. It must be in your account, visible and editable to you, not deleted and open (409 deal_closed otherwise). The appointment takes the deal's contact and is linked to the deal; the appointment.booked event carries dealId. Disagreeing with contactId or deal_id is a 400.
                deal_id:
                  type: string
                  format: uuid
                  description: Alias of dealId.
                assignedTo:
                  type: string
                  format: uuid
                calendarId:
                  type: string
                  format: uuid
                answers:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                bookingPageId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                notes:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '201':
          description: Appointment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
      parameters:
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
  /appointments/{id}:
    get:
      operationId: getAppointment
      summary: Get an appointment by ID
      tags:
      - Appointments
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: Appointment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
    patch:
      operationId: updateAppointment
      summary: Update an appointment
      tags:
      - Appointments
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Appointment updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                answers:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                assignedTo:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                description:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                endTime:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                location:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                notes:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                startTime:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                status:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                title:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
    delete:
      operationId: deleteAppointment
      summary: Delete an appointment
      tags:
      - Appointments
      parameters:
      - $ref: '#/components/parameters/IdParam'
      - name: dry_run
        in: query
        required: false
        description: Validate the mutation without persisting changes.
        schema:
          type: boolean
      - name: sandbox
        in: query
        required: false
        description: Run the mutation in sandbox mode.
        schema:
          type: boolean
      responses:
        '200':
          description: Appointment deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id: {}
                      status:
                        type: string
                      replayed:
                        type: boolean
                      cleanupComplete: {}
                required:
                - data
  /appointments/{id}/outcome/undo:
    post:
      x-generated: true
      operationId: postAppointmentsIdOutcomeUndo
      summary: Create / invoke appointments id outcome undo
      tags:
      - Appointments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
  /appointments/{id}/outcome:
    post:
      x-generated: true
      operationId: postAppointmentsIdOutcome
      summary: Create / invoke appointments id outcome
      tags:
      - Appointments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - outcome
              properties:
                outcome:
                  type: string
                  enum:
                  - completed
                  - no_show
                  - cancelled
                  - rescheduled
                  description: The outcome to record. completed, no_show and cancelled become the appointment status; rescheduled moves the appointment to startTime/endTime and keeps its status. When Pipeline settings (appointmentOutcomeStages) map the outcome for the deal's pipeline, the contact's most recently updated open deal moves to that stage — in the same transaction.
                startTime:
                  description: 'rescheduled only (required then): the new start, ISO 8601 with timezone offset. A slot equal to the appointment''s current start and end is refused with 422 reschedule_unchanged ("Pick a different time"); nothing is written The pattern above is the server''s rule (Zod''s ISO date-time check). It also accepts minute precision without seconds (2026-12-01T10:00Z), which an RFC 3339 `format: date-time` validator refuses; send seconds for portability.'
                  type: string
                  format: date-time
                  pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                endTime:
                  description: 'rescheduled only (required then): the new end, ISO 8601 with timezone offset The pattern above is the server''s rule (Zod''s ISO date-time check). It also accepts minute precision without seconds (2026-12-01T10:00Z), which an RFC 3339 `format: date-time` validator refuses; send seconds for portability.'
                  type: string
                  format: date-time
                  pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
              description: 'Conditional request requirements: rescheduled needs startTime and endTime. Flat requiredFields are intentionally omitted; read endpoint notes/description and validation errors for valid field combinations. Rules the route enforces: rescheduled needs startTime and endTime A rescheduled outcome requires both startTime and endTime.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
components:
  schemas:
    DataEnvelope:
      type: object
      properties:
        data:
          description: Response payload (shape varies by endpoint)
  parameters:
    IdParam:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Resource UUID
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API key authentication. Generate keys in Settings > API Keys.

        Keys use the `cdy_` prefix.


        Example: `Authorization: Bearer cdy_a1b2c3d4e5f6...`

        '
x-mcp:
  transport:
  - stdio
  - http
  orchestration: code
  endpoint_tools: hidden