Skip to main content
POST
Create List

Authorizations

x-api-key
string
header
required

Body

application/json

Create a list from companies sent as JSON (a file goes to /companies/lists/upload).

companies
CompanyIn · object[]
required

Companies by domain; repeats are dropped.

Minimum array length: 1
name
string | null

The list's name (default: "Companies ").

list_id
string | null

Your own id for the list: a UUID (e.g. crypto.randomUUID()); left out, one is generated. Sending the same id again returns the same list.

Response

Successful Response

A company list.

list_id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
resolving,
ready
count
integer
required
counts
Counts · object
created_at
string<date-time> | null
updated_at
string<date-time> | null
companies
CompanyListItemView · object[] | null
added
integer | null
skipped
SkippedLine · object[]
skipped_count
integer
default:0