Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Companies API companies API

The companies API from The Companies API — 13 operation(s) for companies.

The Companies API companies 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 companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 15 operations across 13 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.

15 operations 13 paths 9 schemas 11 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.thecompaniesapi.com/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

The Companies API companies 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 15

Across 13 paths, the API surfaces 15 operations — 11 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

companies 15
GET
/v2/companies
Search companies using a segmentation query.
searchCompanies 12 params → 200401403
POST
/v2/companies
Search companies using a segmentation query.
searchCompaniesPost body → 200401403
GET
/v2/companies/{domain}
Get a single company data by its domain.
fetchCompany 3 params → 200401403404
GET
/v2/companies/by-name
Search companies by name.
searchCompaniesByName 11 params → 200400401403
GET
/v2/companies/by-prompt
Search companies by prompt.
searchCompaniesByPrompt 9 params → 200401403
GET
/v2/companies/similar
Get similar companies from one or many domains.
searchSimilarCompanies 9 params → 200401403
GET
/v2/companies/count
Get the count of companies using a segmentation query.
countCompanies 4 params → 200401403
POST
/v2/companies/count
Get the count of companies using a segmentation body.
countCompaniesPost body → 200401403
GET
/v2/companies/by-email
Get a company data by email.
fetchCompanyByEmail 3 params → 200401403
GET
/v2/companies/by-social
Get a company data by social media.
fetchCompanyBySocial 15 params → 200401403
GET
/v2/companies/{domain}/email-patterns
Get email patterns for a company by its domain.
fetchCompanyEmailPatterns 3 params → 200401403404
POST
/v2/companies/{domain}/ask
Ask a question about a company by its domain.
askCompany 1 param body → 200401403404
GET
/v2/companies/{domain}/context
Get the full context of a company by its domain.
fetchCompanyContext 1 param → 200401403404
GET
/v2/companies/analytics
Fetch analytics data for search segmentations and lists.
fetchCompaniesAnalytics 6 params → 200401
POST
/v2/companies/analytics/export
Export analytics data for search segmentations and lists.
exportCompaniesAnalytics body → 200401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PageContentsIdeated (28 properties), CompanyV2 (21 properties), Prompt (12 properties), PaginationMeta (9 properties). Each schema is shown below with its type and property counts.

PageContentsPage
object
A page content saved as a source for a company context.
8 properties 1 required
PageContentsIdeated
object
A collection of categorized facts about a company aggregated from multiple sources.
28 properties
PaginationMeta
object
Metadata about a paginated or billed response.
9 properties 8 required
SegmentationCondition
object
A condition for our platform segmentation engine.
5 properties 4 required
PageContentsLink
object
A link found in a page content.
2 properties 1 required
EmailPattern
object
An email pattern and its related informations.
4 properties 4 required
CompanyV2
object
Our complete schema for company data.
21 properties
Prompt
object
A natural language request made to the platform resolving to a specific action or search segment.
12 properties 4 required
LLMAnswer
object
An answer from a query made to the LLM.
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thecompaniesapi-companies-api-openapi.yml Raw ↑

Other APIs The Companies API publishes across the network.

The Companies API actions API
The Companies API analytics API
The Companies API industries API
The Companies API job-titles API
The Companies API lists API
The Companies API locations API
The Companies API prompts API
The Companies API teams API
The Companies API technologies API
The Companies API users API
The Companies API utilities API