Conduyt API Keys API

openapi: 3.2.0
info:
  title: Conduyt API Keys 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: API Keys
  description: API key management
paths:
  /api-keys:
    get:
      operationId: listApiKeys
      summary: List API keys (owner/admin only)
      description: Returns API key metadata. Never returns the full key.
      tags:
      - API Keys
      responses:
        '200':
          description: List of API keys
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      data: {}
                      meta: {}
                    required:
                    - data
                    - meta
                required:
                - data
        '403':
          $ref: '#/components/responses/Forbidden'
      parameters:
      - 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: 25
          minimum: 1
          maximum: 100
        x-default-provenance: handler_literal
    post:
      operationId: createApiKey
      summary: Generate a new API key (owner/admin only)
      description: Returns the full key exactly once. Store it securely.
      tags:
      - API Keys
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                scopes:
                  type: array
                  items:
                    type: string
                expiresAt:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                ipAllowlist:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                rateLimit:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                tier:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                unrestricted:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '200':
          description: API key created (includes full key)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      keyPrefix:
                        type: string
                      key:
                        type: string
                        description: Full API key (shown once)
                      createdAt:
                        type: string
                        format: date-time
                      permissions: {}
                    required:
                    - key
                    - permissions
                required:
                - data
        '403':
          $ref: '#/components/responses/Forbidden'
      parameters: []
  /api-keys/check:
    get:
      operationId: checkApiKey
      summary: Check current API key metadata
      description: Returns tier, scopes, rate limit, IP allowlist, and usage for the API key used on the request.
      tags:
      - API Keys
      responses:
        '200':
          description: API key metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      key: {}
                      scopes: {}
                      network: {}
                      rateLimit: {}
                      usage: {}
                      account: {}
                    required:
                    - key
                    - scopes
                    - network
                    - rateLimit
                    - usage
                    - account
                required:
                - data
        '400':
          description: Request was not authenticated with an API key
      parameters: []
  /api-keys/{id}:
    patch:
      operationId: updateApiKey
      summary: Update an API key
      description: Update key name, tier, scopes, IP allowlist, rate limit, and optional expiry. API-key auth cannot manage API keys.
      tags:
      - API Keys
      parameters:
      - $ref: '#/components/parameters/IdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                tier:
                  type: string
                  enum:
                  - read
                  - write
                  - admin
                scopes:
                  type: array
                  items:
                    type: string
                ipAllowlist:
                  type: array
                  items:
                    type: string
                rateLimit:
                  type: integer
                  minimum: 1
                  maximum: 10000
                expiresAt:
                  type:
                  - string
                  - 'null'
                  format: date-time
                cascadeConfirmKeys:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                cascadeConfirmed:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                expectedScopes:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
                unrestricted:
                  description: Read by the handler from the JSON body (the route declares no schema for its type).
      responses:
        '200':
          description: API key updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      cascade: {}
                    required:
                    - cascade
                required:
                - data
        '403':
          $ref: '#/components/responses/Forbidden'
    delete:
      operationId: revokeApiKey
      summary: Revoke an API key
      tags:
      - API Keys
      parameters:
      - $ref: '#/components/parameters/IdParam'
      responses:
        '200':
          description: API key revoked
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      revoked: {}
                      descendantsRevoked: {}
                    required:
                    - success
                    - revoked
                    - descendantsRevoked
                required:
                - data
    get:
      x-generated: true
      operationId: getApiKeysId
      summary: Get api-keys id
      tags:
      - API Keys
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope'
components:
  responses:
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable error code (e.g., TRIAL_EXPIRED, PLAN_LIMIT_REACHED)
    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