Login

Retrieve companies from your lists with our API

Retrieve detailed information on companies in your lists with our API. Manage and update your company data effortlessly.

Fetch companies in your list

Free

This endpoint allows you to fetch companies in your lists.

Query parameters

pagenumber (optional)

The page to fetch (default to 1).

/lists/:listId/companies?page=1

sizenumber (optional)

The number of companies to be returned (between 1 and 100). Default to 10.

/lists/:listId/companies?size=10

querystring (required)

The query to filter the companies inside your list.

Make sure this parameter is stringified and encoded.

GET
https://api.thecompaniesapi.com/v2/lists/:listId/companies?query=%5B%7B%22attribute%22%3A%22about.industries%22%2C%22operator%22%3A%22or%22%2C%22sign%22%3A%22equals%22%2C%22values%22%3A%5B%22retail%22%2C%22internet%22%2C%22services%22%5D%7D%2C%7B%22attribute%22%3A%22locations.headquarters.country.code%22%2C%22operator%22%3A%22or%22%2C%22sign%22%3A%22equals%22%2C%22values%22%3A%5B%22us%22%2C%22fr%22%2C%22gb%22%5D%7D%5D&token=XXXXXX
The endpoint that defines your search criteria.
sortFieldsstring (optional)

An array of multiple fields combined to sort the results.

…/lists/:listId/companies?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D

Make sure this parameter is stringified and encoded.

sortKeystring (optional)

The field to sort the results.

…/lists/:listId/companies?sortKey=meta.score

Possible values

about.businessType
about.industries
about.industry
about.name
about.totalEmployees
about.yearFounded
analytics.monthlyVisitors
apps
codes.naics
codes.sic
Show 13 more
sortOrderstring (optional)

The order to sort the results.

…/lists/:listId/companies?sortOrder=asc

Possible values

asc
desc

Response

companiesarray

The companies that belong to your list.

Browse all datapoints
metaobject

The metas information.

Endpoint
GET
https://api.thecompaniesapi.com/v2/lists/:listId/companies