Conduyt Conversations API

openapi: 3.2.0
info:
  title: Conduyt Conversations 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: Conversations
  description: Threaded conversation view per contact
paths:
  /conversations:
    get:
      operationId: listConversations
      summary: List conversation threads
      tags:
      - Conversations
      parameters:
      - name: channel
        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: search
        in: query
        required: false
        description: Full-text search query
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      responses:
        '200':
          description: Paginated conversations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data: {}
                      meta: {}
                    required:
                    - data
                    - meta
                required:
                - data
  /conversations/{contactId}:
    get:
      operationId: getConversation
      summary: Get conversation thread for a contact
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: around
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: channel
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: per_page
        in: query
        required: false
        description: Items per page (max 200)
        schema:
          type: integer
          default: 50
          minimum: 1
          maximum: 100
        x-default-provenance: handler_literal
      responses:
        '200':
          description: Messages for this contact thread
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      contact: {}
                      conversation: {}
                      messages: {}
                      notes: {}
                      meta: {}
                    required:
                    - contact
                    - conversation
                    - messages
                    - notes
                    - meta
                required:
                - data
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      x-generated: true
      operationId: patchConversationsContactId
      summary: Update conversations contactId
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ok:
                        type: boolean
                    required:
                    - ok
                required:
                - data
  /conversations/{contactId}/compliance:
    get:
      x-generated: true
      operationId: getConversationsContactIdCompliance
      summary: Get conversations contactId compliance
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      - name: phone
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      phoneSms: {}
                      flags: {}
                      suppressions: {}
                      timeline: {}
                    required:
                    - phoneSms
                    - flags
                    - suppressions
                    - timeline
                required:
                - data
    post:
      x-generated: true
      operationId: postConversationsContactIdCompliance
      summary: Create / invoke conversations contactId compliance
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                optOut:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                phone:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      optedOut: {}
                      phone: {}
                      normalizedPhone: {}
                    required:
                    - phone
                    - normalizedPhone
                required:
                - data
  /conversations/{contactId}/state:
    get:
      x-generated: true
      operationId: getConversationsContactIdState
      summary: Get conversations contactId state
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
    patch:
      x-generated: true
      operationId: patchConversationsContactIdState
      summary: Update conversations contactId state
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ownerId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                priority:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                slaMinutes:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                snoozedUntil:
                  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).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
  /conversations/export:
    get:
      x-generated: true
      operationId: getConversationsExport
      summary: List conversations export
      tags:
      - Conversations
      parameters:
      - name: channel
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: Query parameter read by this route.
        schema:
          type: string
      responses:
        '200':
          description: CSV file (attachment)
          content:
            text/csv:
              schema:
                type: string
                format: binary
  /conversations/metrics:
    get:
      x-generated: true
      operationId: getConversationsMetrics
      summary: List conversations metrics
      tags:
      - Conversations
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      periodDays:
                        type: number
                      messages: {}
                      conversations: {}
                      replyRatePct: {}
                    required:
                    - periodDays
                    - messages
                    - conversations
                    - replyRatePct
                required:
                - data
  /conversations/{contactId}/suggestion:
    get:
      x-generated: true
      operationId: getConversationsContactIdSuggestion
      summary: Get conversations contactId suggestion
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
    post:
      x-generated: true
      operationId: postConversationsContactIdSuggestion
      summary: Create / invoke conversations contactId suggestion
      tags:
      - Conversations
      parameters:
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                decision:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                messageId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                sentMessageId:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ok:
                        type: boolean
                      messageId: {}
                      decision: {}
                    required:
                    - ok
                    - messageId
                    - decision
                required:
                - data
components:
  schemas:
    DataEnvelope:
      type: object
      properties:
        data:
          description: Response payload (shape varies by endpoint)
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable error code (e.g., TRIAL_EXPIRED, PLAN_LIMIT_REACHED)
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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