API-referanse
Destinations
Push destinations (Attio, HubSpot, …)
Denne siden finnes foreløpig bare på engelsk.
GET
/api/destinationsAPI keyList push destinations
Returns all configured push destinations (Attio, HubSpot, webhook, etc.) for the authenticated API key's account.
Responses
200Successful response.
401Missing or invalid API key.
402Trial expired. Upgrade required.
429Rate limit or quota exceeded.
POST
/api/destinationsAPI keyCreate push destination
Creates a new push destination. Config fields are encrypted at rest. Returns the created destination with a 201 status.
Body
min 1 chars, max 100 chars
"attio" | "comptoir" | "webhook" | "hubspot" | "twenty"
Default: true
Responses
200Successful response.
401Missing or invalid API key.
402Trial expired. Upgrade required.
429Rate limit or quota exceeded.
GET
/api/destinations/{name}API keyGet a push destination
Fetch a single push destination by its unique name.
Path parameters
Responses
200Successful response.
401Missing or invalid API key.
402Trial expired. Upgrade required.
429Rate limit or quota exceeded.
POST
/api/push/{destinationName}API keyPush companies to a destination
Sends enriched company profiles for the specified org numbers to the named push destination. Requires canPush tier permission.
Path parameters
Body
Responses
200Successful response.
401Missing or invalid API key.
402Trial expired. Upgrade required.
429Rate limit or quota exceeded.