Get Competitor CRM Properties

GET

crm

competitor-properties

curl "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/crm/competitor-properties",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
)

await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

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

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

curl "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/crm/competitor-properties",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
)

await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

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

Authorizations

Authorization

string

header

required

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

Query Parameters

provider

enum<string>

required

The CRM to read or change: hubspot, salesforce or attio. That CRM must be connected to your workspace.

Available options:

hubspot,

salesforce,

attio

Response

The competitor properties for this CRM

success

boolean

required

Example:

true

data

object

required

Show child attributes

curl "https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/crm/competitor-properties",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    params={"provider": "hubspot"},
)

await fetch("https://api.clustr-ai.com/api/public/crm/competitor-properties?provider=hubspot", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

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

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 Competitor CRM Properties

Errors

Authorizations

Query Parameters

Response

​Errors

Authorizations

Query Parameters

Response

Errors