The Companies API LogoThe Companies API Logo
APICompaniesUse casesPricing
LoginLogin

Add or remove companies in your lists

Add or remove companies in your lists using their domain names or IDs.

Add or remove companies in your list

1 credit per company added

Use this endpoint to manage companies in your lists by adding (attaching) or removing (detaching) them using their domains or IDs. You can modify up to 1,000 companies per api request.

Query parameters

actionstring (optional)

The action to perform on the companies: 'attach' to add them to the list, or 'detach' to remove them from the list.

Possible values

attach
detach
domainsarray (optional)

An array of company domains (e.g. ['microsoft.com', 'apple.com']) to add or remove from the list. Maximum 1,000 domains.

companyIdsarray (optional)

An array of company IDs to add or remove from the list (each ID for a company is available in metas.mysqlId). Maximum 1,000 company IDs.

Response

list. analyticsobject

The analytics of the list.

list. createdAtdate

When the list was created.

2022-02-22T07:23:52.000+00:00

list. dynamicboolean

If the list is dynamic or static.

true

list. idnumber

The id of the list.

3838

list. importedboolean

If the list has been imported.

true

list. integrationsarray

The integrations associated with the list.

list. namestring

The name of the list

SaaS with 100k+ MRR

list. processActiveboolean

The process active status of the list (for internal use).

true

list. processInitializedboolean

The process initialized flag (for internal use).

true

list. processingAtdate

When the list is being processed.

2022-02-22T07:23:52.000+00:00

list. queryarray

The query used to generate the list.

Endpoint
PATCH
https://api.thecompaniesapi.com/v2/lists/:listId/companies/toggle
API response
{analytics :{companiesCount :30992,},createdAt : "2022-04-01T13:07:14.000+00:00" ,dynamic :false,id :4246,imported :false,integrations :[ ],name : "SaaS with 100k+ MRR" ,processActive :false,processInitialized :true,processingAt : "2022-04-01T13:07:15.000+00:00" ,query :[ ],}
A glowing background image to highlight the titleA glowing background image to highlight the title
© 2025 The Companies API
  • Updates
  • Terms
  • Privacy
  • FAQ
  • Status

Fast-growing SaaS companies with remote teams