Get Client Rule

GET

client-companies

rule

{provider}

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

{
  "success": true,
  "data": {
    "rule": {
      "enabled": true,
      "field": "customer_status",
      "fieldLabel": "Customer status",
      "fieldType": "single_select",
      "values": ["active"],
      "valueLabels": ["Active"],
      "wonDeal": true,
      "match": "any",
      "updatedAt": "2026-10-01T09:12:00Z"
    }
  }
}

Reads the rule that decides which of a connected CRM’s companies are your clients. rule is null when none is set, and then no companies come from that CRM. A company is a client when it matches a company property condition (field and the values that mean client), when it has a won deal (wonDeal), or both. match says whether either is enough (any) or both must hold (all). See CRM rule for how each CRM marks a won deal. The companies the rule marks join your client list, which every feature reads.

Errors

Status	Code	When
404	`CRM_NOT_CONNECTED`	That CRM is not connected for this workspace
404	`UNKNOWN_PROVIDER`	`provider` is not one of the three

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

{
  "success": true,
  "data": {
    "rule": {
      "enabled": true,
      "field": "customer_status",
      "fieldLabel": "Customer status",
      "fieldType": "single_select",
      "values": ["active"],
      "valueLabels": ["Active"],
      "wonDeal": true,
      "match": "any",
      "updatedAt": "2026-10-01T09:12:00Z"
    }
  }
}

Authorizations

Authorization

string

header

required

The API key you created on the API settings page of the Clustr app.

Path Parameters

provider

enum<string>

required

The CRM whose client rule to use. It must be connected to your workspace.

Available options:

hubspot,

salesforce,

attio

Response

The rule, or null

success

boolean

Example:

true

data

object

Show child attributes

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

{
  "success": true,
  "data": {
    "rule": {
      "enabled": true,
      "field": "customer_status",
      "fieldLabel": "Customer status",
      "fieldType": "single_select",
      "values": ["active"],
      "valueLabels": ["Active"],
      "wonDeal": true,
      "match": "any",
      "updatedAt": "2026-10-01T09:12:00Z"
    }
  }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Notes

Record Activity

Tags

Target Accounts

Client Companies

Excluded Companies

Buyer Titles

ICP

Competitor Monitoring

Connector Refresh

Notifications

Get Client Rule

Errors

Authorizations

Path Parameters

Response

​Errors

Authorizations

Path Parameters

Response

Errors