THthecompaniesapi

lists

POST /v2/lists/{listId}/companies

Get companies in a list with a segmentation body.

Request

Base URL
https://api.thecompaniesapi.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/thecompaniesapi/apis/the-companies-api/docs/v2/lists/:listId/companies/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

listIdnumber required

Request body

actionIdnumber

pagenumber

simplifiedboolean

sizenumber

sortKey'about.businessType' | 'about.industries' | 'about.industry' | 'about.name' | 'about.totalEmployees' | 'about.yearFounded' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.domain' | 'domain.tld' | 'finances.revenue' | 'locations.headquarters.city.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'technologies.active' | 'urls'

sortOrder'asc' | 'desc'

Response

Get companies in a list with a segmentation body.

Changes

No recorded changes to this operation across all 1 revision of this API.