Create a list of companies with our API

Create and manage lists of companies tailored to your specifications with our API. Organize your data efficiently.

Create a list of companies

This endpoint allows you to create a list of companies.

Body parameters

dynamicboolean (optional)

If the list is dynamic. When set to true, the list will be updated automatically when new companies are added to the database.

Possible values

false

true

namestring (required)

The name of the list.

typestring (required)

The type of list to create.

Possible values

companies

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

French NodeJS Companies

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

POST

https://api.thecompaniesapi.com/v2/lists

API response

{analytics :{…},createdAt : "2022-04-01T13:07:14.000+00:00" ,dynamic :false,id :4246,imported :false,integrations :[ ],name : "French NodeJS Companies" ,processActive :false,processInitialized :true,processingAt : "2022-04-01T13:07:15.000+00:00" ,query :[ ],}