> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clustr-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Intros by Company

> The warm intros grouped by connector: each group is one connector with their intros to prospects at the companies the filters keep. Takes the People list's filters. `relationship.confidence_score` is a percentage here, 0 to 100.

Each group is one connector with their warm intros to prospects at the companies your filters
keep. Here `relationship.confidence_score` is a percentage, 0 to 100.


## OpenAPI

````yaml GET /v2/intros/by_company
openapi: 3.1.0
info:
  title: Clustr API
  description: >
    Programmatic access to your Clustr network: import connectors, search warm
    intros, and manage target accounts.


    ## Authentication

    All endpoints require a Bearer token (API key) in the `Authorization`
    header.


    ```

    Authorization: Bearer <your_api_key>

    ```


    API keys can be created and managed from the [API settings
    page](https://app.clustr-ai.com/api).
  version: '2.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v2/intros/by_company:
    get:
      tags:
        - Search
      summary: List Intros by Company
      description: >-
        The warm intros grouped by connector: each group is one connector with
        their intros to prospects at the companies the filters keep. Takes the
        People list's filters. `relationship.confidence_score` is a percentage
        here, 0 to 100.
      operationId: listIntrosByCompany
      parameters:
        - $ref: '#/components/parameters/ClustrFresh'
        - name: q
          in: query
          required: false
          description: >-
            Only the intros whose prospect's name, title or company, connector's
            name or industry holds this text, in any case.
          schema:
            type: string
        - name: exclude_customers
          in: query
          required: false
          description: Absent follows the workspace's setting.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: full_history
          in: query
          required: false
          description: true adds every engagement.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: include_all_positions
          in: query
          required: false
          description: true adds each person's positions; needs a bounded page_size.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: include
          in: query
          required: false
          description: >-
            Optional. Leave it out for the full answer, as before. Name the
            heavy parts you want back, comma-separated, or `none` for the base
            intro alone (the primary shared experiences, the experience counts
            and the engagement totals stay).

            - `engagements`: `relationship.engagement.history` (with
            `full_history=true`).

            - `shared_experiences`: `relationship.shared_experience_history` and
            `shared_education_experience_history`.
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: account_tag
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: added
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: big_company_max_employees
          in: query
          required: false
          deprecated: true
          description: Ignored. The "Hide big companies" filter was removed.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: cities
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: customers
          in: query
          required: false
          description: >-
            Keep intros whose connector currently works at the company with this
            name, matched case-insensitively; the same filter as
            client_companies. Repeat the parameter for several companies.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: connector_crm_statuses
          in: query
          required: false
          description: >-
            The same statuses as `crm_statuses`, matched on the connector only;
            the same filter as client_crm_statuses. Repeat the parameter for
            several values.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: connector_linkedin_urls
          in: query
          required: false
          description: >-
            Keep intros whose connector has this LinkedIn profile URL; the same
            filter as client_linkedin_urls. Repeat the parameter for several
            connectors.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: client_names
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: client_public_identifiers
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: connector_role
          in: query
          required: false
          description: >-
            Keep only the intros whose connector is part of your network; the
            same filter as client_role, and it wins when both are sent.
            `network` is the only value; any other value returns 400.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: competitor
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: confidence_ranges
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: countries
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: created_after
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: created_before
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: crm_statuses
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: cursor.direction
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: cursor.last_id
          in: query
          required: false
          description: >-
            The last intro id of the previous page, for cursor paging; the same
            as cursor.lastId.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: cursor.last_score
          in: query
          required: false
          description: >-
            The last score of the previous page, for cursor paging; the same as
            cursor.lastScore.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: dismiss_reason
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: company_owner
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: assigned_owner
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: company_deal_stage
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: customer_of
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: domains
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: employee_ranges
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: engagement_types
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: evidence
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: fit
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: has_interaction
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: has_notes
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: hide_big_company_overlaps
          in: query
          required: false
          deprecated: true
          description: Ignored. The "Hide big companies" filter was removed.
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: icp_fit
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: include_unengaged
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: industries
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: job_id
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: buyer_title_id
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: linkedin_urls
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: numeric_ids
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: owner
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: owners
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: page
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: page_size
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_companies
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_crm_statuses
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_job_function
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_linkedin_urls
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_names
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_positions
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: prospect_seniority_rank
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: revenue_ranges
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: seniority_levels
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: sort_direction
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: sort_field
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: statuses
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: tag
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: target_account
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: temperature
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: tier
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: vanity_names
          in: query
          required: false
          description: A People list filter (see GET /v1/internal/referral).
          explode: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Typed result envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSearchResponseEnvelope'
              example:
                success: true
                data:
                  results:
                    - client:
                        name: Sofia Rossi
                        first_name: Sofia
                        last_name: Rossi
                        linkedin_url: https://www.linkedin.com/in/sofia-rossi
                        job_title: Chief Operating Officer
                        company_name: Northwind Logistics
                        location: Lyon, France
                        country: France
                        seniority_level: C-Level
                        owner_email: alex.martin@halden.io
                        owner_name: Alex Martin
                        connector_tags:
                          - Champion
                        headline: Chief Operating Officer at Northwind Logistics
                        positions:
                          - company_name: Northwind Logistics
                            linkedin_numeric_id: sofia-rossi
                            linkedin_vanity_name: sofia-rossi
                            domain: northwind.io
                            job_title: Chief Operating Officer
                            is_current: true
                            is_primary: true
                        profile_picture_url: >-
                          https://media.licdn.com/dms/image/v2/D4E03AQ/profile-displayphoto-shrink_200_200/0/1700000000000
                      intros:
                        - intro_id: 299c9699-bfe1-49f8-a476-8267b6a28a8f
                          prospect:
                            name: James Walker
                            first_name: James
                            last_name: Walker
                            linkedin_url: https://www.linkedin.com/in/jameswalker
                            job_title: Director of Engineering
                            company_name: Northwind Logistics
                            location: Lyon, France
                            country: France
                            seniority_level: Director
                            owner_email: alex.martin@halden.io
                            owner_name: Alex Martin
                            connector_tags:
                              - Champion
                            headline: Director of Engineering at Northwind Logistics
                            positions:
                              - company_name: Northwind Logistics
                                linkedin_numeric_id: jameswalker
                                linkedin_vanity_name: jameswalker
                                domain: northwind.io
                                job_title: Director of Engineering
                                is_current: true
                                is_primary: true
                            profile_picture_url: >-
                              https://media.licdn.com/dms/image/v2/D4E03AQ/profile-displayphoto-shrink_200_200/0/1700000000000
                          company:
                            name: Northwind Logistics
                            linkedin_url: >-
                              https://www.linkedin.com/company/northwind-logistics
                            linkedin_numeric_id: '18472301'
                            linkedin_vanity_name: '18472301'
                            domain: northwind.io
                            industry: Transportation & Logistics
                            employee_count: '320'
                            revenue: $10M-$50M
                            country: France
                            logo_url: >-
                              https://media.licdn.com/dms/image/v2/C4D0BAQ/company-logo_200_200/0/1700000000000
                          relationship:
                            confidence_score: 82
                            total_overlap_months: 18
                            shared_experience:
                              company_name: Northwind Logistics
                              overlap_months: 18
                              connector_role: member
                              prospect_role: member
                              is_current: true
                              connector_location: Lyon, France
                              prospect_location: Lyon, France
                              same_location: true
                              same_country: true
                              location_match_type: city
                              location_granularity: city
                              location_match_source: hq
                              colleague_label: Former colleague
                            shared_education_experience:
                              institution_name: HEC Paris
                              overlap_months: 18
                            engagement:
                              total_engagements: 12
                              last_engagement_date: '2026-11-03'
                              history:
                                - type: default
                                  date: '2026-11-03'
                                  text: Congratulations on the launch!
                                  link: >-
                                    https://app.clustr-ai.com/accounts/acc_0ewr9dy46v0c75h0nkrb1qvpxy
                                  context: >-
                                    Worked together at Acme Analytics from 2019
                                    to 2022.
                                  source: linkedin
                            shared_experience_history:
                              - company_name: Northwind Logistics
                                overlap_months: 18
                                connector_role: member
                                prospect_role: member
                                is_current: true
                                connector_location: Lyon, France
                                prospect_location: Lyon, France
                                same_location: true
                                same_country: true
                                location_match_type: city
                                location_granularity: city
                                location_match_source: hq
                                colleague_label: Former colleague
                            shared_experience_count: 3
                            shared_education_experience_history:
                              - institution_name: HEC Paris
                                overlap_months: 18
                            shared_education_experience_count: 3
                            has_linkedin_connection: true
                            has_endorsement: true
                            endorsements:
                              - direction: outbound
                                skills:
                                  - Negotiation
                                received_at: '2026-10-28T16:02:05Z'
                                skill_details:
                                  - name: Thomas Lefevre
                                    total_endorsements: 12
                                    capped: false
                          is_target_company: true
                          tracking:
                            status_id: 32b6d29d-400d-42fc-a445-4f54161b1cc8
                            status_name: Thomas Lefevre
                            status_color: '#3B82F6'
                            status_is_terminal: true
                            notes: Met at SaaStr; follow up after Q1 planning.
                            assigned_at: '2026-09-30T12:00:00Z'
                            notes_updated_at: '2026-09-30T12:00:00Z'
                            notes_updated_by_name: Alex Martin
                          dismissed: false
                          dismiss_reason: not_relevant
                          dismissed_at: '2026-11-12T07:45:00Z'
                  total: 128
                  page: 1
                  page_size: 50
                  has_more: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    ClustrFresh:
      name: X-Clustr-Fresh
      in: header
      required: false
      description: >-
        Send `1` for about 10 seconds after a write of your own: the read waits
        up to `queries.clickhouse.write_wait_ms` (default 6 s) for that write
        and is never answered from a last-good copy. Do not send it on every
        request.
      schema:
        type: string
        enum:
          - '1'
  schemas:
    PublicSearchResponseEnvelope:
      example:
        success: true
        data:
          results:
            - client:
                name: Halden
                first_name: Alex
                last_name: Martin
                linkedin_url: https://www.linkedin.com/in/alex-martin
                job_title: Head of Revenue Operations
                company_name: Halden
                location: Paris
                country: France
                seniority_level: Seniority level
                owner_email: alex.martin@halden.io
                owner_name: Alex Martin
                connector_tags:
                  - Priority
                headline: Head of Revenue Operations
                positions:
                  - company_name: Halden
                    is_current: true
                    is_primary: true
                profile_picture_url: https://halden.io
              intros:
                - intro_id: 085fd6d6-f476-4325-a6c1-6163568b138c
                  prospect:
                    name: Alex Martin
                  relationship:
                    confidence_score: 82
                    total_overlap_months: 12.5
                  is_target_company: true
          total: 12
          page: 1
          page_size: 25
          has_more: false
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PublicSearchResponse'
    PublicSearchResponse:
      type: object
      required:
        - results
        - total
        - page
        - page_size
        - has_more
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/schemas-PublicClientResult'
        total:
          type: integer
          format: int64
        page:
          type: integer
        page_size:
          type: integer
        has_more:
          type: boolean
    ErrorEnvelope:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          description: Always false.
        error:
          $ref: '#/components/schemas/ErrorInfo'
    schemas-PublicClientResult:
      type: object
      required:
        - client
        - intros
      properties:
        client:
          allOf:
            - $ref: '#/components/schemas/schemas-PublicPerson'
        intros:
          type: array
          items:
            $ref: '#/components/schemas/schemas-PublicIntroData'
    ErrorInfo:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: >-
            What a client branches on, such as BAD_REQUEST or NOT_FOUND: one of
            the codes listed, the same on every operation. A code is added
            within a major version, never renamed.
          enum:
            - ADMIN_REQUIRED
            - ALREADY_LISTED
            - API_REQUEST_FAILED
            - ATTIO_NOT_CONNECTED
            - ATTIO_WORKSPACE_NOT_FOUND
            - AUTHORIZATION_UNAVAILABLE
            - AUTH_CONTEXT_ERROR
            - AUTH_FAILED
            - AUTH_METHOD_UNSUPPORTED
            - BAD_GATEWAY
            - BAD_REQUEST
            - BIGQUERY_ERROR
            - BODY_TOO_LARGE
            - BULK_PUSH_TOO_LARGE
            - BUYER_TITLES_UNAVAILABLE
            - CANCELLED
            - CANNOT_CHANGE_OWN_ROLE
            - CANNOT_DEACTIVATE_SELF
            - CANNOT_REMOVE_SELF
            - CLEANING_REPORT_FAILED
            - CLEANING_REPORT_UNAVAILABLE
            - CLIENT_CLOSED_REQUEST
            - COMPANY_NOT_FOUND
            - COMPANY_NOT_RESOLVED
            - COMPETITOR_EXISTS
            - COMPETITOR_READ_FAILED
            - COMPETITOR_RUN_FAILED
            - CONFLICT
            - CRM_CAPABILITY_UNSUPPORTED
            - CRM_CREDENTIAL_EXPIRED
            - CRM_DAILY_LIMIT
            - CRM_LISTS_UNSUPPORTED
            - CRM_NOT_ACTIVE
            - CRM_NOT_CONNECTED
            - CRM_RATE_LIMITED
            - CRM_RECONNECT_REQUIRED
            - CRM_ROW
            - CRM_SCHEMA_UNAVAILABLE
            - CRM_SCOPE_MISSING
            - CRM_UNAVAILABLE
            - CRM_VALUES_UNAVAILABLE
            - CRM_WRITE_DISABLED
            - CUSTOMERS_UNAVAILABLE
            - DATABASE_NOT_FOUND
            - DATASET_NOT_FOUND
            - DUPLICATE_ALREADY_RESOLVED
            - DUPLICATE_CHECK_FAILED
            - EMAIL_NOTIFIER_UNAVAILABLE
            - ENTITLEMENT_UNAVAILABLE
            - ESCALATION_EMAIL_DISABLED
            - EXPORT_FAILED
            - EXPORT_IN_FLIGHT
            - EXPORT_UNAVAILABLE
            - FAMILY_CLUSTER
            - FEATURE_NOT_ENABLED
            - FINDING_NOT_APPLICABLE
            - FIRE_FAILED
            - FORBIDDEN
            - FULLENRICH_API_ERROR
            - FULLENRICH_UNEXPECTED_ERROR
            - GATEWAY_TIMEOUT
            - HEADERS_TOO_LARGE
            - HUBSPOT_NOT_CONNECTED
            - HUBSPOT_UPSTREAM_ERROR
            - INSUFFICIENT_CREDITS
            - INSUFFICIENT_PERMISSION
            - INTEGRATION_REAUTH_REQUIRED
            - INTERNAL_ERROR
            - INVALID_BODY
            - INVALID_BOOLEAN
            - INVALID_BUCKET
            - INVALID_COMPANY_NAME
            - INVALID_CREDENTIALS
            - INVALID_CUSTOMER_RULE
            - INVALID_ENDPOINT
            - INVALID_EVENT
            - INVALID_FIELD
            - INVALID_INPUT
            - INVALID_LINKEDIN_URL
            - INVALID_MAPPING
            - INVALID_MATCHING_SETTINGS
            - INVALID_OBJECT_TYPE
            - INVALID_REQUEST
            - INVALID_SCHEDULE
            - INVALID_SETTINGS
            - INVALID_SIGNATURE
            - INVALID_TARGET_LIST
            - INVALID_TENANT_ID
            - INVALID_TOKEN
            - INVALID_URL
            - INVALID_UUID
            - INVALID_WEBSITE_URL
            - JOB_CLIENT_NOT_CONFIGURED
            - JOB_CREATION_FAILED
            - JOB_NOT_FOUND
            - KEY_NOT_REGISTERED
            - LAST_ADMIN
            - LOAD_FAILED
            - MAPPING_NOT_FOUND
            - MATCHING_SETTINGS_CONFLICT
            - MATCHING_VERSION_NOT_FOUND
            - MERGES_DISABLED
            - MERGE_UNRESOLVED
            - MERGE_UNSUPPORTED
            - METHOD_NOT_ALLOWED
            - MISSING_FIELDS
            - MISSING_HEADER
            - MISSING_JOB_ID
            - MISSING_OBJECT_ID
            - MISSING_PORTAL_ID
            - MISSING_TENANT_ID
            - MISSING_USER_ID
            - NOT_APPLIED
            - NOT_AUTO_SAFE
            - NOT_CONFIGURED
            - NOT_CONNECTED
            - NOT_DUPLICATE_CLUSTER
            - NOT_ENABLED
            - NOT_FOUND
            - NOT_RETRYABLE
            - NOT_REVERTABLE
            - NO_ACTIVE_WAREHOUSE
            - NO_BUYER_TITLES
            - NO_CONNECTION
            - NO_LINKEDIN_URL
            - NO_MATCH_KEY
            - NO_ORG
            - NO_PACKAGE
            - NO_SLOT
            - NO_TEAM_FOUND
            - NO_TOKEN
            - NO_WEBSITE
            - ORG_LIMIT_EXCEEDED
            - PANIC_RECOVERED
            - PARSE_ERROR
            - PAYLOAD_TOO_LARGE
            - PAYMENT_REQUIRED
            - PERSON_LEFT
            - PORTAL_TENANT_MISMATCH
            - PRIVATE_CHANNEL_NEEDS_INVITE
            - PROCESSING_ERROR
            - PROFILE_NOT_RESOLVED
            - PROJECT_NOT_FOUND
            - PROPERTY_INSIGHTS_FAILED
            - PROPERTY_INSIGHTS_UNAVAILABLE
            - QUEUE_UNAVAILABLE
            - RATE_LIMITED
            - RATE_LIMITER_INIT_FAILED
            - RATE_LIMIT_EXCEEDED
            - REDIRECT_REFUSED
            - REFRESH_RATE_LIMITED
            - REFRESH_UNAVAILABLE
            - REPORT_ONLY_DUPLICATE
            - REQUEST_FAILED
            - RESEARCH_NOT_STARTED
            - RESOURCE_EXHAUSTED
            - RESPONSE_READ_FAILED
            - REVERT_BATCH_UNAVAILABLE
            - REVERT_CONFLICT
            - REVERT_EXPIRED
            - ROUTE_NOT_FOUND
            - SALESFORCE_NOT_CONNECTED
            - SALESFORCE_ORG_NOT_FOUND
            - SAVE_FAILED
            - SEARCH_FAILED
            - SERVICE_NOT_FOUND
            - SERVICE_UNAVAILABLE
            - SERVICE_UNREACHABLE
            - SETUP_FAILED
            - SETUP_RATE_LIMITED
            - SLACK_REJECTED
            - SNOWFLAKE_ERROR
            - STAFF_REQUIRED
            - SUPABASE_NEEDS_POOLER
            - SYNC_IN_PROGRESS
            - SYNC_PROPERTIES_DISABLED
            - SYNC_STATUS_UNAVAILABLE
            - SYNC_UNAVAILABLE
            - TABLE_SHAPE_MISMATCH
            - TARGET_ACCOUNTS_UNAVAILABLE
            - TARGET_LIST_NOT_BINDABLE
            - TARGET_LIST_NOT_FOUND
            - TASK_CREATION_FAILED
            - TENANT_LOOKUP_FAILED
            - TENANT_MISMATCH
            - TOO_MANY_HEADERS
            - TOO_SOON
            - UNAUTHORIZED
            - UNAVAILABLE
            - UNKNOWN_ERROR
            - UNKNOWN_FEATURE
            - UNKNOWN_PORTAL
            - UNKNOWN_PROVIDER
            - UNPROCESSABLE_ENTITY
            - UNSUPPORTED_FLOW
            - UNSUPPORTED_MEDIA_TYPE
            - UNSUPPORTED_OBJECT_TYPE
            - UNSUPPORTED_PROVIDER
            - UNSUPPORTED_RESOURCE_TYPE
            - UPSTREAM_ERROR
            - UPSTREAM_UNAVAILABLE
            - URL_TOO_LONG
            - USER_NOT_AUTHORIZED
            - VALIDATION_ERROR
            - VALUES_FAILED
            - VALUES_UNAVAILABLE
            - VERIFICATION_UNAVAILABLE
            - WEBHOOK_UNAVAILABLE
        message:
          type: string
          description: The sentence a person reads.
        details:
          type: string
          description: Developer text, returned outside production only.
        request_id:
          type: string
          description: >-
            The request's id, for support. Always set, and the same as the
            X-Request-ID response header.
    schemas-PublicPerson:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        linkedin_url:
          type: string
        job_title:
          type: string
        company_name:
          type: string
        location:
          type: string
        country:
          type: string
        seniority_level:
          type: string
        owner_email:
          type: string
        owner_name:
          type: string
        connector_tags:
          type: array
          items:
            type: string
        headline:
          type: string
        positions:
          type: array
          items:
            $ref: '#/components/schemas/schemas-PublicPosition'
        profile_picture_url:
          type: string
          description: The person's LinkedIn profile picture. Omitted when we have none.
    schemas-PublicIntroData:
      type: object
      required:
        - intro_id
        - prospect
        - relationship
        - is_target_company
      properties:
        intro_id:
          type: string
        prospect:
          allOf:
            - $ref: '#/components/schemas/schemas-PublicPerson'
        company:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/schemas-PublicCompany'
        relationship:
          allOf:
            - $ref: '#/components/schemas/PublicRelationship'
        is_target_company:
          type: boolean
        tracking:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PublicIntroTracking'
        dismissed:
          type: boolean
          description: True when the opportunity is dismissed. Absent otherwise.
        dismiss_reason:
          type: string
          description: Why it was dismissed, when a reason was given.
        dismissed_at:
          type: string
          format: date-time
          description: When it was dismissed.
    schemas-PublicPosition:
      type: object
      required:
        - company_name
        - is_current
        - is_primary
      properties:
        company_name:
          type: string
        linkedin_numeric_id:
          type: string
        linkedin_vanity_name:
          type: string
        domain:
          type: string
        job_title:
          type: string
        is_current:
          type: boolean
        is_primary:
          type: boolean
    schemas-PublicCompany:
      type: object
      required:
        - name
        - linkedin_url
        - linkedin_numeric_id
        - domain
        - industry
        - employee_count
        - revenue
      properties:
        name:
          type: string
        linkedin_url:
          type: string
        linkedin_numeric_id:
          type: string
        linkedin_vanity_name:
          type: string
        domain:
          type: string
        industry:
          type: string
        employee_count:
          type: string
        revenue:
          type: string
        country:
          type: string
        logo_url:
          type: string
          description: The company's logo. Omitted when we have none.
    PublicRelationship:
      type: object
      required:
        - confidence_score
        - total_overlap_months
      properties:
        confidence_score:
          type: number
          format: double
          description: 'A percentage, 0 to 100: the row''s 0..1 strength x 100.'
          minimum: 0
          maximum: 100
        total_overlap_months:
          type: number
          format: double
        shared_experience:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PublicSharedExperience'
        shared_education_experience:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PublicSharedEducationExperience'
        engagement:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PublicEngagementMetrics'
        shared_experience_history:
          type: array
          items:
            $ref: '#/components/schemas/PublicSharedExperience'
        shared_experience_count:
          type: integer
        shared_education_experience_history:
          type: array
          items:
            $ref: '#/components/schemas/PublicSharedEducationExperience'
        shared_education_experience_count:
          type: integer
        has_linkedin_connection:
          type: boolean
          description: >-
            True when the two are 1st-degree LinkedIn connections. Omitted
            otherwise.
        has_endorsement:
          type: boolean
          description: >-
            True when one endorsed the other's skills on LinkedIn. Omitted
            otherwise.
        endorsements:
          type: array
          description: The pair's skill endorsements, on every row with has_endorsement.
          items:
            $ref: '#/components/schemas/PublicEndorsement'
    PublicIntroTracking:
      type: object
      properties:
        status_id:
          type: string
        status_name:
          type: string
        status_color:
          type: string
        status_is_terminal:
          type: boolean
        notes:
          type: string
        assigned_at:
          type: string
        notes_updated_at:
          type: string
        notes_updated_by_name:
          type: string
    PublicSharedExperience:
      type: object
      required:
        - company_name
        - overlap_months
        - is_current
      properties:
        company_name:
          type: string
        overlap_months:
          type: number
          format: double
        connector_role:
          type: string
        prospect_role:
          type: string
        is_current:
          type: boolean
        connector_location:
          type: string
        prospect_location:
          type: string
        same_location:
          type: boolean
          nullable: true
        same_country:
          type: boolean
          nullable: true
        location_match_type:
          type: string
        location_granularity:
          type: string
        location_match_source:
          type: string
        colleague_label:
          type: string
    PublicSharedEducationExperience:
      type: object
      required:
        - institution_name
        - overlap_months
      properties:
        institution_name:
          type: string
        overlap_months:
          type: number
          format: double
    PublicEngagementMetrics:
      type: object
      required:
        - total_engagements
      properties:
        total_engagements:
          type: integer
        last_engagement_date:
          type: string
        history:
          type: array
          items:
            $ref: '#/components/schemas/PublicEngagementDetail'
    PublicEndorsement:
      type: object
      required:
        - direction
        - skills
      properties:
        direction:
          type: string
          description: >-
            The connector's side: given (the connector endorsed the prospect) or
            received.
        skills:
          type: array
          items:
            type: string
          description: The endorsed skills, most endorsed first.
        received_at:
          type: string
          format: date-time
          description: When Clustr first saw it. LinkedIn does not say when it was given.
        skill_details:
          type: array
          description: >-
            For each skill in skills, in its order, the endorsed person's total
            endorsements.
          items:
            $ref: '#/components/schemas/PublicEndorsedSkill'
    PublicEngagementDetail:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          description: >-
            prospect_liked, prospect_reacted, prospect_commented,
            prospect_recommended, client_liked, client_reacted, client_commented
            or client_recommended.
        date:
          type: string
        text:
          type: string
        link:
          type: string
        context:
          type: string
        source:
          type: string
    PublicEndorsedSkill:
      type: object
      required:
        - name
        - total_endorsements
      properties:
        name:
          type: string
        total_endorsements:
          type: integer
          description: How many people endorsed the person for this skill on LinkedIn.
        capped:
          type: boolean
          description: >-
            LinkedIn caps the total it shows (99+), so the real total may be
            higher.
  responses:
    BadRequest:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing or invalid auth.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalServerError:
      description: Unexpected server-side failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: The API key you created on the API settings page of the Clustr app.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.