Compelling Integrations API

CRM and third-party integrations with field mapping configuration.

GitHub OpenAPI

Operations 16

GET /workspaces/{workspace_id}/integrations List integrations #
GET /workspaces/{workspace_id}/integrations/{provider} Get integration state #
DELETE /workspaces/{workspace_id}/integrations/{provider} Disconnect provider #
POST /workspaces/{workspace_id}/integrations/{provider}/validate Validate credentials #
GET /workspaces/{workspace_id}/integrations/{provider}/account-mappings List account mappings #
POST /workspaces/{workspace_id}/integrations/{provider}/account-mappings Create account mapping #
DELETE /workspaces/{workspace_id}/integrations/{provider}/account-mappings/{mapping_id} Delete account mapping #
GET /workspaces/{workspace_id}/integrations/{provider}/account-question-mappings List account question mappings #
POST /workspaces/{workspace_id}/integrations/{provider}/account-question-mappings Create account question mapping #
DELETE /workspaces/{workspace_id}/integrations/{provider}/account-question-mappings/{mapping_id} Delete account question mapping #
GET /workspaces/{workspace_id}/integrations/{provider}/contact-mappings List contact mappings #
POST /workspaces/{workspace_id}/integrations/{provider}/contact-mappings Create contact mapping #
DELETE /workspaces/{workspace_id}/integrations/{provider}/contact-mappings/{mapping_id} Delete contact mapping #
GET /workspaces/{workspace_id}/integrations/{provider}/contact-question-mappings List contact question mappings #
POST /workspaces/{workspace_id}/integrations/{provider}/contact-question-mappings Create contact question mapping #
DELETE /workspaces/{workspace_id}/integrations/{provider}/contact-question-mappings/{mapping_id} Delete contact question mapping #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/compelling-ai:compelling-ai-integrations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

compelling-ai-integrations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compelling Ai Integrations API
  version: 1.0.0
  contact:
    name: Compelling
    url: https://compelling.ai
  description: 'Operations tagged Integrations across 2 of this provider''s published API definitions: compelling-ai-openapi.yaml, compelling-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.compelling.ai/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Integrations
  description: CRM and third-party integrations with field mapping configuration.
paths:
  /workspaces/{workspace_id}/integrations:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    get:
      tags:
      - Integrations
      summary: List integrations
      description: Returns the connection state of all supported providers for this workspace.
      operationId: getIntegrations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Integration'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    get:
      tags:
      - Integrations
      summary: Get integration state
      operationId: getIntegration
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integration'
    delete:
      tags:
      - Integrations
      summary: Disconnect provider
      description: Disconnects the integration and deletes all associated mappings.
      operationId: disconnectIntegration
      responses:
        '204':
          description: Disconnected
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/validate:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    post:
      tags:
      - Integrations
      summary: Validate credentials
      description: Tests provider credentials before connecting. Useful for API-key–based providers.
      operationId: validateIntegration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 'Provider-specific credential payload (e.g. `{ "api_key": "..." }`).'
              additionalProperties: true
      responses:
        '200':
          description: Credentials valid
        '422':
          description: Credentials invalid
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/account-mappings:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    get:
      tags:
      - Integrations
      summary: List account mappings
      description: Field mappings between provider account fields and Compelling account properties.
      operationId: getAccountMappings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldMapping'
    post:
      tags:
      - Integrations
      summary: Create account mapping
      operationId: createAccountMapping
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldMappingInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMapping'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/account-mappings/{mapping_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    - $ref: '#/components/parameters/mapping_id'
    delete:
      tags:
      - Integrations
      summary: Delete account mapping
      operationId: deleteAccountMapping
      responses:
        '204':
          description: Deleted
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/account-question-mappings:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    get:
      tags:
      - Integrations
      summary: List account question mappings
      description: Mappings between provider fields and account insight columns.
      operationId: getAccountQuestionMappings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldMapping'
    post:
      tags:
      - Integrations
      summary: Create account question mapping
      operationId: createAccountQuestionMapping
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldMappingInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMapping'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/account-question-mappings/{mapping_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    - $ref: '#/components/parameters/mapping_id'
    delete:
      tags:
      - Integrations
      summary: Delete account question mapping
      operationId: deleteAccountQuestionMapping
      responses:
        '204':
          description: Deleted
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/contact-mappings:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    get:
      tags:
      - Integrations
      summary: List contact mappings
      description: Field mappings between provider contact fields and Compelling contact properties.
      operationId: getContactMappings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldMapping'
    post:
      tags:
      - Integrations
      summary: Create contact mapping
      operationId: createContactMapping
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldMappingInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMapping'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/contact-mappings/{mapping_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    - $ref: '#/components/parameters/mapping_id'
    delete:
      tags:
      - Integrations
      summary: Delete contact mapping
      operationId: deleteContactMapping
      responses:
        '204':
          description: Deleted
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/contact-question-mappings:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    get:
      tags:
      - Integrations
      summary: List contact question mappings
      description: Mappings between provider fields and contact insight columns.
      operationId: getContactQuestionMappings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldMapping'
    post:
      tags:
      - Integrations
      summary: Create contact question mapping
      operationId: createContactQuestionMapping
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldMappingInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMapping'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/integrations/{provider}/contact-question-mappings/{mapping_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/provider'
    - $ref: '#/components/parameters/mapping_id'
    delete:
      tags:
      - Integrations
      summary: Delete contact question mapping
      operationId: deleteContactQuestionMapping
      responses:
        '204':
          description: Deleted
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
components:
  schemas:
    Integration:
      type: object
      properties:
        provider:
          type: string
          example: hubspot
        status:
          type: string
          enum:
          - connected
          - disconnected
          - error
        connected_at:
          type: string
          format: date-time
          nullable: true
    FieldMappingInput:
      type: object
      required:
      - provider_field
      - compelling_field
      - direction
      properties:
        provider_field:
          type: string
          example: hs_company_size
        compelling_field:
          type: string
          example: employee_count
        direction:
          type: string
          enum:
          - import
          - export
          - both
    FieldMapping:
      type: object
      properties:
        id:
          type: string
          example: map_01HX
        provider_field:
          type: string
          example: hs_company_size
        compelling_field:
          type: string
          example: employee_count
        direction:
          type: string
          enum:
          - import
          - export
          - both
  parameters:
    provider:
      name: provider
      in: path
      required: true
      schema:
        type: string
        enum:
        - hubspot
        - pipedrive
        - google-sheets
    workspace_id:
      name: workspace_id
      in: path
      required: true
      schema:
        type: string
      example: ws_01HX
    mapping_id:
      name: mapping_id
      in: path
      required: true
      schema:
        type: string
      example: map_01HX
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key issued from your workspace settings. Pass as `Authorization: Bearer <token>`.'
x-refined-from:
- compelling-ai-openapi.yaml
- compelling-ai-openapi.yml