Use the Partner API to integrate Cust with your own systems. Its interactive reference contains endpoint schemas, required fields, and response examples:

Authentication and region

Generate an API key in Settings → API keys. Use the API host for the region containing your workspace.

Send the key in the Authorization header with the Token scheme:

Authorization: Token YOUR_API_KEY

Keep the key in your server's secret storage. Do not put it in a public page, browser application, or shared documentation.

Available resources

Resource	Use
Bulk imports	Submit an import job and inspect its processing status and results.
File uploads	Request the upload details needed for a file-based import.
Metrics	List or retrieve the metric definitions available to your workspace.
Health evaluations	Retrieve recorded company health evaluations and their changes over time.

Endpoints are under /v1/. The machine-readable OpenAPI schema is available at /schema/ on either regional host. Follow the current reference for upload and import request bodies; importing a file is an asynchronous operation, so check the job result after submission.

Read health evaluations

Health evaluations are read-only through this API. You can filter by company, creation time, current or previous score, and whether the score changed.

For example, to retrieve changes for a company identified by your external ID on the EU deployment:

curl --get 'https://partner-api.cust.co/v1/health-evaluations/'   --header "Authorization: Token ${CUST_API_KEY}"   --data-urlencode 'company=extid-YOUR_COMPANY_ID'   --data-urlencode 'changed=true'

Use a numeric Cust company ID or the extid- prefix followed by its external ID. Creation-time filters include created_at_gte, created_at_gt, created_at_lte, and created_at_lt. Use the score values defined in the API schema.

Results use cursor pagination. Follow the response's next URL until it is empty. The first evaluation is treated as a change because there is no previous score.

To refresh an account's health in the product, use the company's health controls. A read request to this endpoint does not run a new evaluation.

For a manual file upload through the product, see Data import.