> ## 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. # Preview Client Rule > Count the companies a draft client rule would select, without saving it Runs a draft rule against the CRM and answers how many of its companies would count as clients, with a few of their names. Nothing is saved. Takes the same body as [Set Client Rule](https://docs.clustr-ai.com/api-reference/set-client-rule.md). `count` can be a lower bound when the CRM stops counting early; `countIsLowerBound` says so. The rule, as [Set Client Rule](https://docs.clustr-ai.com/api-reference/set-client-rule.md#body) takes it. ## Errors | Status | Code | When | | - | - | - | | 400 | `INVALID_CLIENT_RULE` | The draft is not a valid rule for this CRM | | 404 | `CRM_NOT_CONNECTED` | That CRM is not connected for this workspace | | 502 | `CRM_UNAVAILABLE`, `CRM_SCHEMA_UNAVAILABLE` | The CRM could not be reached | ```bash cURL theme={null} curl -X POST https://api.clustr-ai.com/api/public/client-companies/rule/hubspot/preview \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"wonDeal": true}' ``` ```json 200 theme={null} { "success": true, "data": { "count": 214, "countIsLowerBound": false, "sample": [ { "name": "Acme Corp", "domain": "acme.com" }, { "name": "Initech", "domain": "initech.com" } ] } } ``` ## OpenAPI ````yaml POST /client-companies/rule/{provider}/preview 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 ``` 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/rule/{provider}/preview: parameters: - $ref: '#/components/parameters/ClientRuleProvider' post: tags: - Client Companies summary: Preview Client Rule description: | How many CRM companies a draft rule would mark as clients, with a few of their names. Your saved rule stays as it is. operationId: previewClientRule requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ClientRuleRequest' responses: '200': description: The count and a sample content: application/json: schema: type: object properties: success: type: boolean example: true data: type: object properties: count: type: integer countIsLowerBound: type: boolean description: >- True when the CRM stopped counting early, so at least `count` companies match. sample: type: array items: type: object properties: name: type: string domain: type: string '400': description: The rule is invalid for this CRM (`INVALID_CLIENT_RULE`) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Invalid or missing API key '404': description: >- The CRM is not connected (`CRM_NOT_CONNECTED`), or the provider is unknown content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: >- The CRM could not be reached (`CRM_UNAVAILABLE`, `CRM_SCHEMA_UNAVAILABLE`) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: ClientRuleProvider: name: provider in: path required: true schema: type: string enum: - hubspot - salesforce - attio description: >- The CRM whose client rule to use. It must be connected to your workspace. schemas: ClientRuleRequest: type: object description: | Who counts as a client in one CRM: a company property condition (`field`, `fieldType` and the `values` that mean client), a won deal (`wonDeal`), or both, combined by `match`. properties: confirm: type: boolean description: >- Set Client Rule only (Preview Client Rule ignores it). Changing or turning off a rule that is on can remove companies from your client list, so such a save writes nothing and answers `confirmationRequired: true` with `currentRuleMatches`, `newRuleMatches`, `countIsLowerBound`, a `sample` and a `message`. Send the same request with `confirm` set to true to apply it. enabled: type: boolean description: >- Whether the rule applies. A disabled rule is kept but marks no company as a client. field: type: string description: >- The company property's API name, from the fields endpoint. Omit `field` and `fieldType` for a rule on won deals alone. fieldLabel: type: string description: The property's display name. Filled from the CRM when omitted. fieldType: type: string description: >- `boolean`, `single_select`, `multi_select` or `text`, as the fields endpoint reports it. enum: - boolean - single_select - multi_select - text values: type: array items: type: string description: >- The values that mean client: option values for a dropdown, `["true"]` for a checkbox, exact text for a text property. valueLabels: type: array items: type: string description: Display labels for `values`, in the same order. wonDeal: type: boolean description: | A company with at least one won deal is a client: HubSpot `hs_is_closed_won`, Salesforce `IsWon`, Attio a deal in one of `wonStages`. wonStages: type: array items: type: string description: >- Attio only, and required there with `wonDeal`: the ids of the deal stages that count as won, from `dealStages`. Ignored for HubSpot and Salesforce. wonStageLabels: type: array items: type: string description: 'Attio only: display labels for `wonStages`, in the same order.' match: type: string enum: - any - all default: any description: >- With both conditions, `any` (either is enough) or `all` (both must hold). ErrorResponse: type: object required: - success - error properties: success: type: boolean example: false error: type: object properties: message: type: string example: Invalid request body code: type: string example: BAD_REQUEST 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.