The Companies API lists API is one of 12 APIs that The Companies API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include lists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
8 operations
across 5 paths,
and defines 9 schemas.
It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.thecompaniesapi.com.
8 operations5 paths9 schemas1 DELETE3 GET2 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
The Companies API lists API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (apiKey).
apiKey — The API key to use for authentication, you can get it from your API tokens page.
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
lists 8
GET
/v2/lists
Get and filter your lists.
fetchLists2 params→ 200401
POST
/v2/lists
Create a new list.
createListbody→ 200401
PATCH
/v2/lists/{listId}
Update a list.
updateList1 parambody→ 200400401403
DELETE
/v2/lists/{listId}
Delete a list.
deleteList1 param→ 200400401403
GET
/v2/lists/{listId}/companies
Get companies in a list with a segmentation query.
fetchCompaniesInList9 params→ 200400401403
POST
/v2/lists/{listId}/companies
Get companies in a list with a segmentation body.
fetchCompaniesInListPost1 parambody→ 200400401403
GET
/v2/lists/{listId}/companies/{domain}
Get a company in a list.
fetchCompanyInList2 params→ 200400401403404
PATCH
/v2/lists/{listId}/companies/toggle
Toggle one or more companies in a list.
toggleCompaniesInList1 parambody→ 200400401403404
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are List (22 properties), CompanyV2 (21 properties), Team (14 properties), User (14 properties). Each schema is shown below with its type and property counts.
User
object
A user of the platform.
14 properties9 required
PaginationMeta
object
Metadata about a paginated or billed response.
9 properties8 required
SegmentationCondition
object
A condition for our platform segmentation engine.
5 properties4 required
CompanyV2
object
Our complete schema for company data.
21 properties
Team
object
A collection of users that can access the same resources.
14 properties13 required
ListAnalytics
object
Analytics collection of a list.
3 properties
Action
object
An action tracks a request made to our job queue and its result.
12 properties2 required
LLMAnswer
object
An answer from a query made to the LLM.
7 properties4 required
List
object
A collection of companies saved or imported by a team.
22 properties13 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
