Get client companies summary

GET

client-companies

summary

curl "https://api.clustr-ai.com/api/public/client-companies/summary" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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": ""
      }
    ]
  }
}

{
  "success": false,
  "error": { "message": "Invalid or missing API key", "code": "UNAUTHORIZED" }
}

Counts of your client companies 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, which includes them.

Response

integer

Client companies, one per company.

integer

Of total, the companies where nobody in your network currently works.

object

Companies per source: manual, csv and crm. A company with several sources counts once under each, so these can add up to more than total.

integer

Companies marked “Not a client”.

object[]

One entry per CRM connection that has ever pulled clients. Empty if none has.

Show fields

string

The CRM, such as hubspot, salesforce or attio.

string

The connected CRM account.

string

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 no clients were removed
`held`	The last pull would have removed more than half of this CRM’s clients while the rule had not changed, so nothing was removed
`failed`	The last pull failed; `error` says why

integer

Client rows this CRM currently contributes.

integer

Goes up by one with every finished pull.

string

When the latest pull started, ISO 8601 UTC. Empty if never.

string

When the latest pull finished, ISO 8601 UTC. Empty if never.

string

Why the last pull failed. Empty otherwise.

curl "https://api.clustr-ai.com/api/public/client-companies/summary" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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": ""
      }
    ]
  }
}

{
  "success": false,
  "error": { "message": "Invalid or missing API key", "code": "UNAUTHORIZED" }
}

curl "https://api.clustr-ai.com/api/public/client-companies/summary" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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": ""
      }
    ]
  }
}

{
  "success": false,
  "error": { "message": "Invalid or missing API key", "code": "UNAUTHORIZED" }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Record Activity

Lists

Tags

Account Tags

Target Accounts

Client Companies

ICP

Competitor Monitoring

Connector Refresh

Notifications

Get client companies summary

Response

​Response

Response