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 field_type) and, for a dropdown, its options (whose values go in values). For Attio, the response also carries deal_stages, the deal stages a won deal can mean. Pass the ids you want in won_stages. If the stages could not be read, deal_stages is empty and deal_stages_unavailable 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
Available options:
attio,
hubspot,
salesforce

Response

Typed result envelope.

success
boolean
required
data
object
required