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

# Get client companies summary

> Counts of your client companies, and each CRM's client sync

Counts of your [client companies](https://docs.clustr-ai.com/client-companies.md) and the state of each CRM
that feeds the list.

**Companies marked "Not a client" are left out of `total`, `notInNetwork` and
`bySource`.** They are counted in `excluded` instead. This is why `total` here can
be lower than the `total` from [List client companies](https://docs.clustr-ai.com/api-reference/list-client-companies.md),
which includes them.

```bash cURL theme={null}
curl "https://api.clustr-ai.com/api/public/client-companies/cco_4t2f926sd9zw8yy0he1403rs43" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json 200 theme={null}
{
  "success": true,
  "data": {
    "total": 126,
    "notInNetwork": 41,
    "bySource": { "manual": 12, "csv": 80, "crm": 40 },
    "excluded": 2,
    "crms": [
      {
        "provider": "hubspot",
        "instanceId": "147580550",
        "status": "ok",
        "rowCount": 40,
        "generation": 12,
        "startedAt": "2026-09-15T02:00:04Z",
        "committedAt": "2026-09-15T02:00:31Z",
        "error": ""
      }
    ]
  }
}
```

```json 401 theme={null}
{
  "success": false,
  "error": { "message": "Invalid or missing API key", "code": "UNAUTHORIZED" }
}
```


## OpenAPI

````yaml GET /client-companies/summary
openapi: 3.1.0
info:
  title: Clustr Public API
  description: >
    Programmatic access to your Clustr network: import connectors, search warm
    intros (opportunities), 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: '1.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com/api/public
    description: Production
security:
  - BearerAuth: []
paths:
  /client-companies/summary:
    get:
      tags:
        - Client Companies
      summary: Get client companies summary
      description: |
        Counts of your client companies and the state of each CRM's client pull.
        Companies marked "Not a client" are left out of every count except
        `excluded`.
      operationId: getClientCompaniesSummary
      responses:
        '200':
          description: The summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/ClientCompanySummary'
        '401':
          description: Invalid or missing API key
components:
  schemas:
    ClientCompanySummary:
      type: object
      properties:
        total:
          type: integer
          description: >-
            How many client companies you have, leaving out those marked "Not a
            client".
          example: 126
        notInNetwork:
          type: integer
          description: >-
            Of `total`, the companies where nobody in your network currently
            works.
          example: 41
        bySource:
          type: object
          description: >-
            How many companies come from each source, leaving out those marked
            "Not a client". A company with several sources counts once under
            each, so these can add up to more than `total`.
          properties:
            manual:
              type: integer
              example: 12
            csv:
              type: integer
              example: 80
            crm:
              type: integer
              example: 40
        excluded:
          type: integer
          description: Companies marked "Not a client".
          example: 2
        crms:
          type: array
          description: >-
            One entry per CRM connection that has pulled clients. Empty when no
            CRM has pulled clients yet.
          items:
            $ref: '#/components/schemas/ClientCompanyCrmSync'
    ClientCompanyCrmSync:
      type: object
      description: The state of one CRM connection's client pull.
      properties:
        provider:
          type: string
          description: The CRM, such as `hubspot`, `salesforce` or `attio`.
          example: hubspot
        instanceId:
          type: string
          description: The connected CRM account (portal, org or workspace).
        status:
          type: string
          enum:
            - idle
            - running
            - ok
            - partial
            - held
            - failed
          description: >-
            One of:


            | Status | Meaning |

            |---|---|

            | `idle` | No pull has run yet |

            | `running` | A pull is in progress |

            | `ok` | The last pull finished, and the list matches your CRM |

            | `partial` | The last pull stopped before the end, so every
            existing client was kept |

            | `held` | The last pull would have removed more than half of this
            CRM's clients while the rule had not changed, so every client was
            kept as a safeguard |

            | `failed` | The last pull failed; `error` says why |
        rowCount:
          type: integer
          description: Client rows this CRM currently contributes.
        generation:
          type: integer
          format: int64
          description: A counter that increases by one with every completed pull.
        startedAt:
          type: string
          description: >-
            When the latest pull started, in ISO 8601 UTC. Empty when no pull
            has run.
          example: '2026-09-15T02:00:04Z'
        committedAt:
          type: string
          description: >-
            When the latest pull finished, in ISO 8601 UTC. Empty when no pull
            has finished.
          example: '2026-09-15T02:00:31Z'
        error:
          type: string
          description: Why the last pull failed. Empty otherwise.
  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.