Trigger automated actions like data enrichment, verification, or updates for individual companies or entire lists through our API.
Request an action for a single company, multiple companies, or one of your lists.
1 credit per action
This endpoint enables you to request an action for a single company, multiple companies, or an entire list of companies.
Body parameters
domainsarray (Max length: 100) (optional)
The domains that need to be processed. If you pass more than 100K domains, the request will be split into multiple actions.
["pearson.com","united.com"]
estimateboolean (optional)
Indicates whether you are requesting a price estimate.
Possible values
false
true
jobstring (optional)
The type of task to be performed.
Possible values
enrich-companies
enrich-list
listnumber (optional)
The ID of the list to be processed.
42
Response
actionsarray
The actions that have been triggered by the request.
estimateboolean
Indicates whether you are requesting a price estimate.
Endpoint
POST
https://api.thecompaniesapi.com/v2/actions
API response
{actions :[{cost :10,createdAt : "2024-08-23T17:02:47.296+02:00" ,data :{…},status : "pending" ,type : "jobs:request" ,},],estimate :true,}