Skip to main content
GET
Lists the company properties of a connected CRM that a client rule can use, read live from the CRM. Each has its API name (for field), label, type (for fieldType) and, for a dropdown, its options (whose values go in values). For Attio, the response also carries dealStages, the deal stages a won deal can mean. Pass the ids you want in wonStages. If the stages could not be read, dealStages is empty and dealStagesUnavailable is true; the properties are still listed.

Errors

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 fields

success
boolean
Example:

true

data
object