> ## 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 Competitor CRM Properties > Which competitor facts Clustr writes onto the companies in your CRM Reads which competitor facts Clustr writes onto the companies in one connected CRM, so your team sees in the CRM which accounts use a competitor and when a competitor last engaged them. There are three, and each is off until you turn it on: | Key | What lands on the company | | - | - | | `competitor_customer` | The competitors the company is a customer of, for example `Accord` | | `competitor_confidence` | How sure Clustr is that it is their customer: `confirmed`, `likely` or `possible`. With several competitors, the strongest | | `competitor_last_engagement` | The date a competitor's people last engaged someone at the company | Turn them on with [Set Competitor CRM Properties](https://docs.clustr-ai.com/api-reference/set-competitor-crm-properties.md). Each property has: | Field | Description | | - | - | | `enabled` | Whether Clustr writes it | | `field` | The company field you named. `""` means the default | | `defaultField` | The property Clustr creates on HubSpot. `""` on Salesforce and Attio, where you name the field | | `effectiveField` | The field Clustr writes | ## Errors | Status | Code | When | | - | - | - | | 400 | | `provider` is missing or not one of the three | | 404 | `CRM_NOT_CONNECTED` | That CRM is not connected for this workspace | ```bash cURL theme={null} curl "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \ -H "Authorization: Bearer YOUR_API_KEY" ``` ```python Python theme={null} import requests requests.get( "https://api.clustr-ai.com/api/public/crm/competitor-properties", headers={"Authorization": "Bearer YOUR_API_KEY"}, params={"provider": "hubspot"}, ) ``` ```javascript JavaScript theme={null} await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", { headers: { Authorization: "Bearer YOUR_API_KEY" }, }); ``` ```json 200 theme={null} { "success": true, "data": { "provider": "hubspot", "properties": [ { "key": "competitor_customer", "label": "Competitor customer", "enabled": true, "field": "", "defaultField": "clustr_competitor_customer", "effectiveField": "clustr_competitor_customer" }, { "key": "competitor_confidence", "label": "Competitor customer confidence", "enabled": false, "field": "", "defaultField": "clustr_competitor_confidence", "effectiveField": "clustr_competitor_confidence" }, { "key": "competitor_last_engagement", "label": "Last competitor engagement", "enabled": false, "field": "", "defaultField": "clustr_last_competitor_engagement", "effectiveField": "clustr_last_competitor_engagement" } ] } } ``` ## OpenAPI ````yaml GET /crm/competitor-properties 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: /crm/competitor-properties: parameters: - name: provider in: query required: true description: >- The CRM to read or change: `hubspot`, `salesforce` or `attio`. That CRM must be connected to your workspace. schema: type: string enum: - hubspot - salesforce - attio example: hubspot get: tags: - Competitor Monitoring summary: Get Competitor CRM Properties description: > Returns which competitor facts Clustr writes onto the companies in one connected CRM. There are three, each off until you turn it on: - `competitor_customer`: the competitors the company is a customer of. - `competitor_confidence`: how sure Clustr is, `confirmed`, `likely` or `possible`. - `competitor_last_engagement`: the date a competitor's people last engaged someone at the company. Turn them on with Set Competitor CRM Properties. operationId: getCompetitorCrmProperties responses: '200': description: The competitor properties for this CRM content: application/json: schema: type: object required: - success - data properties: success: type: boolean example: true data: $ref: '#/components/schemas/CompetitorCrmProperties' example: success: true data: provider: hubspot properties: - key: competitor_customer label: Competitor customer enabled: true field: '' defaultField: clustr_competitor_customer effectiveField: clustr_competitor_customer - key: competitor_confidence label: Competitor customer confidence enabled: false field: '' defaultField: clustr_competitor_confidence effectiveField: clustr_competitor_confidence - key: competitor_last_engagement label: Last competitor engagement enabled: false field: '' defaultField: clustr_last_competitor_engagement effectiveField: clustr_last_competitor_engagement '400': description: '`provider` is missing or is not hubspot, salesforce or attio' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Invalid or missing API key '404': description: >- That CRM is not connected to your workspace (code `CRM_NOT_CONNECTED`) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: CompetitorCrmProperties: type: object required: - provider - properties properties: provider: type: string example: hubspot properties: type: array items: type: object required: - key - label - enabled - field - defaultField - effectiveField properties: key: type: string enum: - competitor_customer - competitor_confidence - competitor_last_engagement label: type: string enabled: type: boolean field: type: string description: The field you named. `""` means the default. defaultField: type: string description: >- The property Clustr creates on HubSpot. `""` on Salesforce and Attio. effectiveField: type: string description: The field Clustr writes. 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.