Request an action on one or more companies

These actions are particularly powerful for automating processes within your product using our API.

They enable you to not only enrich companies that aren't yet in our database but also to perform more detailed enrichment on existing ones if needed (such as extracting products for an e-commerce website).

As actions are a new feature in our product, please feel free to reach out with any ideas for additional ones. We’d be happy to discuss them with you.

Signup to access all our API features

Get your 500 free credits and start enriching and searching companies.

No credit card required

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.

Response schema

actionsarray

The actions that have been triggered by the request.

estimateboolean

Indicates whether you are requesting a price estimate.

API response

{actions :[{cost :10,createdAt : "2024-08-23T17:02:47.296+02:00" ,data :{…},status : "pending" ,type : "jobs:request" ,},],estimate :true,}

Code examples

Select your favorite language:

Java

JavaScript

SDK

PHP

Python

Ruby

Rust

import createClient from '@thecompaniesapi/sdk'

const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })

const response = await tca.requestAction({
  domains: ['microsoft.com', 'apple.com'],
  job: 'enrich-companies',
  estimate: false
})

const actions = response.data.actions // Track this via fetchActions
const meta = response.data.meta // Meta information