Compelling Contacts API

People associated with accounts, along with AI-generated insight columns.

GitHub OpenAPI

Operations 8

GET /workspaces/{workspace_id}/lists/{list_id}/contacts List contacts #
POST /workspaces/{workspace_id}/lists/{list_id}/contacts Generate contacts #
GET /workspaces/{workspace_id}/lists/{list_id}/contacts/{contact_id} Get a contact #
DELETE /workspaces/{workspace_id}/lists/{list_id}/contacts/pending Cancel contact generation #
POST /workspaces/{workspace_id}/lists/{list_id}/contacts/insights Add a contact insight column #
PUT /workspaces/{workspace_id}/lists/{list_id}/contacts/insights/{insight_id} Update a contact insight column #
DELETE /workspaces/{workspace_id}/lists/{list_id}/contacts/insights/{insight_id} Remove a contact insight column #
POST /workspaces/{workspace_id}/lists/{list_id}/contacts/insights/{insight_id}/answers Generate answers for a contact insight #

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-contacts-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-contacts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compelling Ai Contacts API
  version: 1.0.0
  contact:
    name: Compelling
    url: https://compelling.ai
  description: 'Operations tagged Contacts 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: Contacts
  description: People associated with accounts, along with AI-generated insight columns.
paths:
  /workspaces/{workspace_id}/lists/{list_id}/contacts:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    get:
      tags:
      - Contacts
      summary: List contacts
      description: Returns paginated contact rows for the list. Pass `view_id` to apply the view's filters and sort order.
      operationId: getContacts
      parameters:
      - name: view_id
        in: query
        description: Apply filters and sorting from this view.
        schema:
          type: string
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/size'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedContacts'
    post:
      tags:
      - Contacts
      summary: Generate contacts
      description: Triggers AI-powered contact discovery for all accounts in the list.
      operationId: generateContacts
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  items:
                    type: string
                  example:
                  - CEO
                  - CTO
                  - VP Engineering
                  description: Target job roles or titles to find.
      responses:
        '202':
          description: Generation started
          headers:
            Location:
              description: URL to poll for job status.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/contacts/{contact_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/contact_id'
    get:
      tags:
      - Contacts
      summary: Get a contact
      description: Fetch a single contact and its insight values by ID. Useful for webhook-driven lookups.
      operationId: getContact
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/contacts/pending:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    delete:
      tags:
      - Contacts
      summary: Cancel contact generation
      operationId: cancelContactGeneration
      responses:
        '204':
          description: Cancelled
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/contacts/insights:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    post:
      tags:
      - Contacts
      summary: Add a contact insight column
      operationId: addContactInsight
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightInput'
      responses:
        '201':
          description: Insight column created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insight'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/contacts/insights/{insight_id}:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/insight_id'
    put:
      tags:
      - Contacts
      summary: Update a contact insight column
      operationId: updateContactInsight
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightInput'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Insight'
    delete:
      tags:
      - Contacts
      summary: Remove a contact insight column
      operationId: deleteContactInsight
      responses:
        '204':
          description: Removed
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
  /workspaces/{workspace_id}/lists/{list_id}/contacts/insights/{insight_id}/answers:
    parameters:
    - $ref: '#/components/parameters/workspace_id'
    - $ref: '#/components/parameters/list_id'
    - $ref: '#/components/parameters/insight_id'
    post:
      tags:
      - Contacts
      summary: Generate answers for a contact insight
      description: Triggers AI research to fill in the insight column for all contacts in the list.
      operationId: generateContactInsightAnswers
      responses:
        '202':
          description: Generation started
          headers:
            Location:
              description: URL to poll for job status.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
    servers:
    - url: https://api.compelling.ai/v1
      description: Production
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          example: resource_not_found
        message:
          type: string
          example: The requested resource could not be found.
    Insight:
      type: object
      properties:
        id:
          type: string
          example: ins_01HX
        list_id:
          type: string
        question:
          type: string
          example: What is the company's primary go-to-market motion?
        column_name:
          type: string
          example: gtm_motion
        status:
          type: string
          enum:
          - idle
          - running
          - complete
          - failed
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        size:
          type: integer
          example: 25
        total:
          type: integer
          example: 342
        total_pages:
          type: integer
          example: 14
    Contact:
      type: object
      properties:
        id:
          type: string
          example: con_01HX
        account_id:
          type: string
          example: acc_01HX
        list_id:
          type: string
          example: lst_01HX
        name:
          type: string
          example: Jane Smith
        title:
          type: string
          example: VP of Engineering
        email:
          type: string
          format: email
          example: jane@acme.com
        linkedin_url:
          type: string
          example: https://linkedin.com/in/janesmith
        insights:
          type: object
          additionalProperties: true
          description: Dynamic key/value map of AI-generated insight column answers.
    PaginatedContacts:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Job:
      type: object
      properties:
        job_id:
          type: string
          example: job_01HX
        status:
          type: string
          enum:
          - pending
          - running
          - complete
          - failed
          example: running
        type:
          type: string
          enum:
          - contact_generation
          - account_insight_answers
          - contact_insight_answers
          - workflow_run
          example: contact_generation
        list_id:
          type: string
          example: lst_01HX
        error:
          type: string
          nullable: true
          description: Error message if status is `failed`.
        result:
          type: object
          nullable: true
          description: Summary or result data when status is `complete`.
          additionalProperties: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    InsightInput:
      type: object
      required:
      - question
      - column_name
      properties:
        question:
          type: string
          example: What is the company's primary go-to-market motion?
        column_name:
          type: string
          example: gtm_motion
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    size:
      name: size
      in: query
      schema:
        type: integer
        default: 25
        maximum: 100
    insight_id:
      name: insight_id
      in: path
      required: true
      schema:
        type: string
      example: ins_01HX
    list_id:
      name: list_id
      in: path
      required: true
      schema:
        type: string
      example: lst_01HX
    contact_id:
      name: contact_id
      in: path
      required: true
      schema:
        type: string
      example: con_01HX
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
    workspace_id:
      name: workspace_id
      in: path
      required: true
      schema:
        type: string
      example: ws_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