Create a list of companies - The Companies API

You can create lists to organize and group companies according to your needs.

Lists make it easy to categorize companies and quickly retrieve them for future use.

Signup to access all our API features

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

No credit card required

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 schema

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.

API response

{analytics :{…},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 :[ ],}

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.createList({
  name: 'My SaaS List',
})

const newList = response.data // The new list