> ## 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 People

> List the connectors in your network, with the filters of the app's Connectors list

List the connectors in your network : the same rows, filters and order as the
Connectors list in the app. Each connector carries its `clustr_person_id`, how many people they
`may_know_count`, their tags, their owner and whether a keep-fresh slot holds them (`in_slot`).

Narrow the list with the app's filters: `search`, `owner` (from
[List Owners](https://docs.clustr-ai.com/api-reference/list-owners.md)), `job_function`, `seniority_rank`, tags on the connector
(`connector_tag_id`), on their account (`account_tag`) or on their intros (`intro_tag`), and
`tag_group_empty` for connectors with no tag in a field. Tag ids come from
[List Tags](https://docs.clustr-ai.com/api-reference/list-tags.md). Page with `page` and `page_size`.

Use the `clustr_person_id`s it returns as `connector_ids` in
[Set Connectors Owner](https://docs.clustr-ai.com/api-reference/set-connectors-owner.md) and
[Delete Connectors](https://docs.clustr-ai.com/api-reference/delete-connector.md), or as the `connector_id` of
[Set Connector Slot](https://docs.clustr-ai.com/api-reference/set-connector-slot.md).

Leave `include` out and every row is whole. Send `include=none` for the base row alone (the
connector, its ids, current role and company, counts, tags, owner and slot), or name the heavy
parts you want back, comma-separated: `crm` (the connector's own CRM contact, and the company's CRM
match inside `connector_employment`) and `prospects` (the people they may know). A part you leave out is absent from the row, not `null`. An unknown value is a 400 that lists
the allowed ones.

[List Connectors](https://docs.clustr-ai.com/api-reference/list-connectors.md) is the lighter list: one row per connector with
their intro count and owner email, filtered by tag name or owner email.

```bash cURL theme={null}
curl "https://api.clustr-ai.com/v2/people?job_function=engineering&page_size=25" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "contacts": [
      {
        "connector_linkedin_id": "nicdelaye",
        "clustr_person_id": "per_bb771nzbxnmw9dhsnwhbt47j9b",
        "may_know_count": 63,
        "tags": [],
        "in_slot": false,
        "job_function": "engineering"
      }
    ],
    "total": 42,
    "page": 1,
    "page_size": 25,
    "has_more": true
  }
}
```


## OpenAPI

````yaml GET /v2/people
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/people:
    get:
      tags:
        - Network
      summary: List People
      operationId: listPeople
      parameters:
        - $ref: '#/components/parameters/ClustrFresh'
        - name: include
          in: query
          required: false
          style: form
          description: >-
            Optional. Leave it out for the full row, as before. Name the heavy
            parts you want back, comma-separated, or `none` for the base row
            alone.


            - `prospects`: the people the connector may know.

            - `crm`: the connector's own CRM contact, and the company's CRM
            match inside `connector_employment`.
          schema:
            type: array
            items:
              type: string
              enum:
                - none
                - prospects
                - crm
        - name: job_function
          in: query
          required: false
          description: >
            Narrow to connectors whose current title resolves, through

            graph.title_roles, to one of these functions — the same value the

            contact's `job_function` carries. Repeatable, or one comma-separated
            value;

            OR-within. Case-insensitive. Same vocabulary as
            `prospect_job_function` on

            `/v2/intros`; unprefixed because a connector row describes one

            person. Anything else, or an empty value, is a 400.
          schema:
            type: array
            items:
              type: string
          example:
            - engineering
            - product
        - name: seniority_rank
          in: query
          required: false
          description: >
            Narrow to connectors whose current title resolves to one of these
            seniority

            ranks (0 intern … 7 C-suite) — the same `seniority_rank` the contact

            carries. Repeatable, or one comma-separated value; OR-within.
            Distinct from

            `seniority_level`, which is the coarse high / mid / low score; both

            compose. A value outside 0-7, a non-integer, or an empty value is a
            400.
          schema:
            type: array
            items:
              type: string
          example:
            - '5'
            - '6'
            - '7'
        - name: tag_group_empty
          in: query
          required: false
          description: >
            Narrow to connectors carrying NO tag in these tag fields (uuid

            ids): a field column's "No <field>". OR'd with the tags of the same
            field

            selected in `connector_tag_id`, AND'd with every other filter.

            Repeatable, or one comma-separated value. Anything that is not a
            uuid is

            a 400.
          schema:
            type: array
            items:
              type: string
          example:
            - 33333333-3333-3333-3333-333333333333
        - name: account_tag
          in: query
          required: false
          description: >
            Tags on the connector's ACCOUNT (their current company), account tag
            ids

            (uuid). Several ids match a connector carrying ANY of them.
            Repeatable, or one

            comma-separated value. A non-uuid value narrows to nothing.
          schema:
            type: array
            items:
              type: string
          example:
            - 22222222-2222-2222-2222-222222222222
        - name: intro_tag
          in: query
          required: false
          description: >
            Tags on the connector's WARM INTROS, path tag ids (uuid): keeps

            connectors with at least one warm intro carrying them. Several ids
            match

            a connector with warm intros carrying ANY of them. Repeatable, or
            one comma-separated

            value. A non-uuid value narrows to nothing.
          schema:
            type: array
            items:
              type: string
          example:
            - 22222222-2222-2222-2222-222222222222
        - name: page
          in: query
          required: false
          description: 1-based page number. Default 1.
          schema:
            type: integer
            minimum: 1
        - name: page_size
          in: query
          required: false
          description: >-
            Rows per page. Default 25, capped at 50,000 (the CSV export asks for
            every row).
          schema:
            type: integer
            minimum: 1
        - name: search
          in: query
          required: false
          description: >-
            Free text over the connector's name, headline and current job title.
            Case and accent insensitive, contains-match.
          schema:
            type: string
        - name: connector
          in: query
          required: false
          description: Connector linkedin_id. Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: company_name
          in: query
          required: false
          description: Exact current company name. Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: seniority_level
          in: query
          required: false
          description: Coarse seniority score band. Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
              enum:
                - high
                - mid
                - low
          style: form
          explode: true
        - name: country
          in: query
          required: false
          description: >-
            Country name or ISO code, case insensitive; a name also matches its
            ISO code. Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: job_title
          in: query
          required: false
          description: >-
            Contains-match on the current job title, case and accent
            insensitive. Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: connector_tag_id
          in: query
          required: false
          description: >-
            Person tag id (uuid), or `untagged` for connectors with no tag.
            Several ids match a connector carrying ANY of them. Repeatable.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: owner
          in: query
          required: false
          description: >-
            Owner id (uuid) of the connector's owner rule, or `unassigned`.
            Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: owner_id
          in: query
          required: false
          deprecated: true
          description: Former name of `owner`, still accepted.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: icp_fit
          in: query
          required: false
          description: ICP fit of the connector's current company. Repeatable; OR-within.
          schema:
            type: array
            items:
              type: string
              enum:
                - strong
                - partial
                - none
          style: form
          explode: true
        - name: reach
          in: query
          required: false
          description: >
            Reach (may_know_count) in one of these ranges: `N`, `N-M`
            (inclusive)

            or `N+`. Repeatable, or one comma-separated value; OR-within.
          schema:
            type: array
            items:
              type: string
          example:
            - '0'
            - 1-10
            - 201+
        - name: reach_targets
          in: query
          required: false
          description: >
            Target reach (prospects at target accounts) in one of these ranges,
            as

            `reach`. A connector whose snapshot has not computed it matches
            none.
          schema:
            type: array
            items:
              type: string
          example:
            - 1-2
            - 11+
        - name: reach_icp
          in: query
          required: false
          description: |
            Reach at ideal customers (prospects at strong or partial ICP-fit
            companies) in one of these ranges, as `reach`.
          schema:
            type: array
            items:
              type: string
          example:
            - 6-25
        - name: kept_fresh
          in: query
          required: false
          description: >
            `yes`: the connector is in a keep-fresh slot; `no`: it is not. Both,
            or

            neither, is no filter. Repeatable, or one comma-separated value.
          schema:
            type: array
            items:
              type: string
          example:
            - 'yes'
        - name: added
          in: query
          required: false
          description: >
            When this workspace first acquired the connector: `7d`, `30d`, `90d`

            (within that many days), `older` (more than 90 days ago), `never`
            (no

            date). Repeatable, or one comma-separated value; OR-within.
          schema:
            type: array
            items:
              type: string
          example:
            - 7d
            - 30d
        - name: exclude_customers
          in: query
          required: false
          description: >
            `true`: count reach without prospects at your customers. When
            Settings >

            companies; `default`: follow Settings > Matching. Anything else is
            false.
          schema:
            type: string
          example: 'true'
        - name: sort
          in: query
          required: false
          description: See the operation description.
          schema:
            type: string
        - name: order
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: requesting_crm_provider
          in: query
          required: false
          description: The CRM the in-CRM context is scoped to.
          schema:
            type: string
      responses:
        '200':
          description: Typed result envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValuableContactsResponseEnvelope'
              example:
                success: true
                data:
                  contacts:
                    - connector_linkedin_id: sofia-rossi
                      clustr_person_id: per_2yc54rt9319363snmzhte7gje4
                      connector:
                        linkedin_id: priya-shah-sales
                        name: Priya Shah
                        headline: VP Sales at Northwind Logistics
                        linkedin_url: https://www.linkedin.com/in/priya-shah-sales
                        profile_image_url: >-
                          https://media.licdn.com/dms/image/v2/D4E03AQ/profile-displayphoto-shrink_200_200/0/1700000000000
                        country: France
                        clustr_person_id: per_6g36gc6ppkb6ztctyaqparw51e
                      connector_employment:
                        job_title: VP Sales
                        is_account: true
                        company_name: Northwind Logistics
                        company_linkedin_numeric_id: '18472301'
                        company_industry: Transportation & Logistics
                        company_size: 201-500
                        company_domain: northwind.io
                        company_logo_url: >-
                          https://media.licdn.com/dms/image/v2/C4D0BAQ/company-logo_200_200/0/1700000000000
                        display_logo_url: >-
                          https://media.licdn.com/dms/image/v2/C4D0BAQ/company-logo_200_200/0/1700000000000
                        company_website: https://northwind.io
                        icp_fit: strong
                        seniority_level: VP
                        company_crm:
                          crm_provider: hubspot
                          crm_company_id: bacb303f-4a2b-4e1a-ab2e-18de1fb920ea
                          name: Northwind Logistics
                          domain: northwind.io
                          industry: Transportation & Logistics
                          website: https://northwind.io
                          employee_count: 320
                          linkedin_vanity: northwind-logistics
                          linkedin_numeric_id: '18472301'
                        clustr_account_id: acc_0ewr9dy46v0c75h0nkrb1qvpxy
                      may_know_count: 3
                      reach_targets: 12
                      reach_icp: 12
                      reach_icp_strong: 12
                      prospects:
                        - id: jameswalker
                          intro_id: d0d3a470-51d8-4416-a3e7-c647e4d2993c
                          full_name: James Walker
                          headline: Director of Engineering at Northwind Logistics
                          linkedin_url: https://www.linkedin.com/in/jameswalker
                          profile_pic_url: >-
                            https://media.licdn.com/dms/image/v2/D4E03AQ/profile-displayphoto-shrink_200_200/0/1700000000000
                          country: France
                          occupation: Director of Engineering
                          strength: 0.74
                          company:
                            id: 972c2a85-487e-4180-a3d6-356c5024c814
                            name: Northwind Logistics
                            logo_url: >-
                              https://media.licdn.com/dms/image/v2/C4D0BAQ/company-logo_200_200/0/1700000000000
                            industry: Transportation & Logistics
                            size: 201-500
                            website: https://northwind.io
                            domain: northwind.io
                            linkedin_url: >-
                              https://www.linkedin.com/company/northwind-logistics
                            icp_fit: strong
                            is_target: true
                            is_customer: true
                            is_account: true
                            fit_score: 0.74
                            fit_grade: A
                            heat: warm
                            last_signal_at: '2026-09-30T12:00:00Z'
                            crm:
                              crm_provider: hubspot
                              crm_company_id: bacb303f-4a2b-4e1a-ab2e-18de1fb920ea
                              name: Northwind Logistics
                              domain: northwind.io
                              industry: Transportation & Logistics
                              website: https://northwind.io
                              employee_count: 320
                              linkedin_vanity: northwind-logistics
                              linkedin_numeric_id: '18472301'
                            has_open_deal: true
                            deal_stage: Negotiation
                            clustr_account_id: acc_1tv550weccbnh1anfwz1gqrxqc
                          connector:
                            id: 08afd1e8-341e-41a6-a566-afc98cdc5c40
                            name: Sofia Rossi
                            headline: Chief Operating Officer at Northwind Logistics
                            linkedin_url: https://www.linkedin.com/in/sofia-rossi
                            profile_pic_url: >-
                              https://media.licdn.com/dms/image/v2/D4E03AQ/profile-displayphoto-shrink_200_200/0/1700000000000
                            country: France
                            clustr_person_id: per_75m596sm3hdc318hmbx5955j6d
                          reason:
                            type: shared_company
                            company_name: Northwind Logistics
                            institution_name: HEC Paris
                            overlap_months: 18
                            is_current: true
                          crm:
                            crm_provider: hubspot
                            crm_contact_id: ff702f91-7375-44d7-afe8-414d3793fca7
                            email: james.walker@northwind.io
                            full_name: James Walker
                            job_title: Director of Engineering
                            company_name: Northwind Logistics
                            phone: +33 4 72 10 20 30
                            last_activity_date: '2026-09-30T12:00:00Z'
                            last_activity_type: email
                            owner_id: 971f2c4e-2eda-4600-a7bd-c55ef8f21680
                            owner_email: alex.martin@halden.io
                            owner_name: Alex Martin
                            lifecycle_stage: customer
                            recent_activities:
                              - crm_activity_id: 1533c8d7-536b-49cd-a4ba-beeff07caadb
                                activity_type: email
                                activity_date: '2026-10-28T16:02:05Z'
                                subject: Intro call with Northwind
                                activity_direction: outbound
                                activity_status: completed
                                activity_outcome: connected
                                duration_minutes: 30
                                body_preview: >-
                                  Hi Sofia, would you introduce me to Thomas at
                                  Northwind Logistics?
                                thread_count: 3
                            recent_deals:
                              - crm_deal_id: 881a8b46-d40e-4f64-ae8f-33ae45bc3288
                                deal_name: James Walker
                                amount: 48000
                                currency: EUR
                                stage: Negotiation
                                pipeline: Sales pipeline
                                close_date: '2026-10-28T16:02:05Z'
                                is_closed: true
                                is_closed_won: true
                          clustr_person_id: per_497820wfkfn7a3enp0dth0f45r
                          clustr_intro_opportunity_id: opp_0r3k40qwxg22cncqvw77t14wbt
                      tags:
                        - id: 843ba873-6577-4a34-ab37-f193509a2df9
                          name: Strategic
                          color: '#3B82F6'
                          assigned_at: '2026-11-12T07:45:00Z'
                          clustr_tag_id: tag_2cj1rf29pmpwncwm5v68vxwzw6
                      owner:
                        owner_id: 971f2c4e-2eda-4600-a7bd-c55ef8f21680
                        email: alex.martin@halden.io
                        first_name: Alex
                        last_name: Martin
                        id: 971f2c4e-2eda-4600-a7bd-c55ef8f21680
                        name: Alex Martin
                        source: linkedin
                        crm_seen: '2026-11-03T09:14:22Z'
                        push_state: synced
                        user_id: eb53c253-1e7d-441c-ad04-e787afc5c2c3
                        clustr_owner_id: own_4dw2w1ads69pkcq2vsawkz5thg
                      crm:
                        crm_provider: hubspot
                        crm_contact_id: ff702f91-7375-44d7-afe8-414d3793fca7
                        email: thomas.lefevre@northwind.io
                        full_name: Thomas Lefevre
                        job_title: Head of Procurement
                        company_name: Northwind Logistics
                        phone: +33 4 72 10 20 30
                        last_activity_date: '2026-10-28T16:02:05Z'
                        last_activity_type: email
                        owner_id: 971f2c4e-2eda-4600-a7bd-c55ef8f21680
                        owner_email: alex.martin@halden.io
                        owner_name: Alex Martin
                        lifecycle_stage: customer
                        recent_activities:
                          - crm_activity_id: 1533c8d7-536b-49cd-a4ba-beeff07caadb
                            activity_type: email
                            activity_date: '2026-09-30T12:00:00Z'
                            subject: Intro call with Northwind
                            activity_direction: outbound
                            activity_status: completed
                            activity_outcome: connected
                            duration_minutes: 30
                            body_preview: >-
                              Hi Sofia, would you introduce me to Thomas at
                              Northwind Logistics?
                            thread_count: 3
                        recent_deals:
                          - crm_deal_id: 881a8b46-d40e-4f64-ae8f-33ae45bc3288
                            deal_name: Thomas Lefevre
                            amount: 48000
                            currency: EUR
                            stage: Negotiation
                            pipeline: Sales pipeline
                            close_date: '2026-09-30T12:00:00Z'
                            is_closed: true
                            is_closed_won: true
                      first_seen_at: '2026-11-03T09:14:22Z'
                      added_at: '2026-11-03T09:14:22Z'
                      added_by: Alex Martin
                      in_slot: true
                      job_function: Procurement
                      seniority_label: Head
                  total: 128
                  page: 1
                  page_size: 50
                  has_more: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '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:
    ValuableContactsResponseEnvelope:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/ValuableContactsResponse'
    ValuableContactsResponse:
      type: object
      required:
        - contacts
        - total
        - page
        - page_size
        - has_more
      properties:
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ValuableContact'
        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'
    ValuableContact:
      type: object
      required:
        - connector_linkedin_id
        - connector
        - connector_employment
        - may_know_count
        - tags
        - in_slot
      properties:
        connector_linkedin_id:
          type: string
        clustr_person_id:
          type: string
        connector:
          $ref: '#/components/schemas/PersonCard'
        connector_employment:
          $ref: '#/components/schemas/PersonEmployment'
        may_know_count:
          type: integer
        reach_targets:
          type:
            - integer
            - 'null'
        reach_icp:
          type:
            - integer
            - 'null'
        reach_icp_strong:
          type:
            - integer
            - 'null'
        prospects:
          type: array
          items:
            $ref: '#/components/schemas/PersonPathItem'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/ConnectorTagSummary'
        owner:
          oneOf:
            - $ref: '#/components/schemas/ConnectorOwner'
            - type: 'null'
        crm:
          anyOf:
            - type: object
              allOf:
                - $ref: '#/components/schemas/components-schemas-ApiCRMContactInfo'
            - type: 'null'
        first_seen_at:
          type:
            - string
            - 'null'
          format: date-time
        added_at:
          type:
            - string
            - 'null'
          format: date-time
        added_by:
          type: string
        in_slot:
          type: boolean
        job_function:
          type: string
        seniority_label:
          type: string
    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.
    PersonCard:
      description: A person's card on their page.
      type: object
      properties:
        linkedin_id:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        headline:
          type:
            - string
            - 'null'
        linkedin_url:
          type:
            - string
            - 'null'
        profile_image_url:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
        clustr_person_id:
          type: string
          description: The Clustr id of `linkedin_id`, a person (`per_...`).
    PersonEmployment:
      description: A person's current job.
      type: object
      properties:
        job_title:
          type:
            - string
            - 'null'
        is_account:
          type:
            - boolean
            - 'null'
          description: The company is one of the tenant's accounts.
        company_name:
          type:
            - string
            - 'null'
        company_linkedin_numeric_id:
          type:
            - string
            - 'null'
        company_industry:
          type:
            - string
            - 'null'
        company_size:
          type:
            - string
            - 'null'
        company_domain:
          type:
            - string
            - 'null'
        company_logo_url:
          type:
            - string
            - 'null'
        display_logo_url:
          type: string
          description: >-
            Our copy of the company's logo, else a logo.dev image URL for its
            domain; absent when neither. On the Connectors list rows.
        company_website:
          type:
            - string
            - 'null'
        icp_fit:
          type:
            - string
            - 'null'
          description: none, partial or strong.
        seniority_level:
          type:
            - string
            - 'null'
          description: high, mid or low.
        company_crm:
          description: The company's match in the tenant's CRM, when it has one.
          anyOf:
            - type: object
              allOf:
                - $ref: '#/components/schemas/schemas-ApiCRMCompanyInfo'
            - type: 'null'
        clustr_account_id:
          type: string
          description: >-
            The Clustr id of `company_linkedin_numeric_id`, an account
            (`acc_...`).
    PersonPathItem:
      description: >-
        One path of a person page. A prospects page fills the prospect's fields
        and company; a connectors page fills connector.
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
        intro_id:
          type:
            - string
            - 'null'
        full_name:
          type:
            - string
            - 'null'
        headline:
          type:
            - string
            - 'null'
        linkedin_url:
          type:
            - string
            - 'null'
        profile_pic_url:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
        occupation:
          type:
            - string
            - 'null'
        strength:
          type:
            - number
            - 'null'
        company:
          oneOf:
            - $ref: '#/components/schemas/PersonPathCompany'
            - type: 'null'
        connector:
          oneOf:
            - $ref: '#/components/schemas/PersonPathConnector'
            - type: 'null'
        reason:
          anyOf:
            - allOf:
                - $ref: '#/components/schemas/PersonPathReason'
            - type: 'null'
        crm:
          description: The prospect's match in the tenant's CRM, when it has one.
          anyOf:
            - type: object
              allOf:
                - $ref: '#/components/schemas/components-schemas-ApiCRMContactInfo'
            - type: 'null'
        clustr_person_id:
          type: string
          description: The person's Clustr id (`per_...`).
        clustr_intro_opportunity_id:
          type: string
          description: The Clustr id of `intro_id`, an intro (`opp_...`).
    ConnectorTagSummary:
      type: object
      required:
        - id
        - name
        - color
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        color:
          type: string
        assigned_at:
          type: string
          format: date-time
        clustr_tag_id:
          type: string
          description: The tag's Clustr id (`tag_...`).
    ConnectorOwner:
      type: object
      required:
        - owner_id
        - user_id
      properties:
        owner_id:
          type: string
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        id:
          type: string
        name:
          type: string
        source:
          type: string
        crm_seen:
          type:
            - string
            - 'null'
        push_state:
          type: string
        user_id:
          type: string
        clustr_owner_id:
          type: string
          description: The owner's Clustr id (`own_...`).
    components-schemas-ApiCRMContactInfo:
      type: object
      required:
        - crm_provider
        - crm_contact_id
      properties:
        crm_provider:
          type: string
        crm_contact_id:
          type: string
        email:
          type: string
        full_name:
          type: string
        job_title:
          type: string
        company_name:
          type: string
        phone:
          type: string
        last_activity_date:
          type: string
          format: date-time
        last_activity_type:
          type: string
        owner_id:
          type: string
        owner_email:
          type: string
        owner_name:
          type: string
        lifecycle_stage:
          type: string
        recent_activities:
          type: array
          items:
            $ref: '#/components/schemas/components-schemas-ApiCRMActivity'
        recent_deals:
          type: array
          items:
            $ref: '#/components/schemas/components-schemas-ApiCRMDeal'
    schemas-ApiCRMCompanyInfo:
      type: object
      required:
        - crm_provider
        - crm_company_id
      properties:
        crm_provider:
          type: string
        crm_company_id:
          type: string
        name:
          type: string
        domain:
          type: string
        industry:
          type: string
        website:
          type: string
        employee_count:
          type: integer
          nullable: true
        linkedin_vanity:
          type: string
        linkedin_numeric_id:
          type: string
    PersonPathCompany:
      description: >-
        The prospect's company on a prospects page, with the Accounts table's
        ranking inputs.
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        logo_url:
          type:
            - string
            - 'null'
        industry:
          type:
            - string
            - 'null'
        size:
          type:
            - string
            - 'null'
        website:
          type:
            - string
            - 'null'
        domain:
          type:
            - string
            - 'null'
        linkedin_url:
          type:
            - string
            - 'null'
        icp_fit:
          type:
            - string
            - 'null'
        is_target:
          type:
            - boolean
            - 'null'
        is_customer:
          type:
            - boolean
            - 'null'
        is_account:
          type:
            - boolean
            - 'null'
        fit_score:
          type:
            - number
            - 'null'
        fit_grade:
          type:
            - string
            - 'null'
        heat:
          type:
            - string
            - 'null'
        last_signal_at:
          type:
            - string
            - 'null'
          format: date-time
        crm:
          description: The company's match in the tenant's CRM, when it has one.
          anyOf:
            - type: object
              allOf:
                - $ref: '#/components/schemas/schemas-ApiCRMCompanyInfo'
            - type: 'null'
        has_open_deal:
          type:
            - boolean
            - 'null'
        deal_stage:
          type:
            - string
            - 'null'
        clustr_account_id:
          type: string
          description: The account's Clustr id (`acc_...`).
    PersonPathConnector:
      description: The connector on a connectors page.
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        headline:
          type:
            - string
            - 'null'
        linkedin_url:
          type:
            - string
            - 'null'
        profile_pic_url:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
        clustr_person_id:
          type: string
          description: The person's Clustr id (`per_...`).
    PersonPathReason:
      description: >-
        The path's warmest overlap. type is colleague (companyName, isCurrent)
        or education (institutionName).
      type: object
      properties:
        type:
          type: string
          nullable: true
        company_name:
          type: string
          nullable: true
        institution_name:
          type: string
          nullable: true
        overlap_months:
          type: number
          nullable: true
        is_current:
          type: boolean
          nullable: true
    components-schemas-ApiCRMActivity:
      type: object
      required:
        - activity_type
        - activity_date
      properties:
        crm_activity_id:
          type: string
        activity_type:
          type: string
        activity_date:
          type: string
          format: date-time
        subject:
          type: string
        activity_direction:
          type: string
        activity_status:
          type: string
        activity_outcome:
          type: string
        duration_minutes:
          type: integer
        body_preview:
          type: string
        thread_count:
          type: integer
    components-schemas-ApiCRMDeal:
      type: object
      required:
        - crm_deal_id
        - deal_name
        - is_closed
        - is_closed_won
      properties:
        crm_deal_id:
          type: string
        deal_name:
          type: string
        amount:
          type: number
          format: double
        currency:
          type: string
        stage:
          type: string
        pipeline:
          type: string
        close_date:
          type: string
          format: date-time
        is_closed:
          type: boolean
        is_closed_won:
          type: boolean
  responses:
    Unauthorized:
      description: Missing or invalid auth.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource does not exist.
      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.