--- title: "GET /v2/companies" method: GET path: "/v2/companies" tags: ["companies"] --- # GET /v2/companies `GET /v2/companies` ## Request - Base URL: `https://api.thecompaniesapi.com` - URL: `https://api.thecompaniesapi.com/v2/companies` - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Search companies using a segmentation query. ## Query parameters - `actionId` number - `domainsToExclude` string - `linkedinToExclude` string - `page` number - `query` SegmentationCondition[] - `attribute` 'about.businessType' | 'about.industries' | 'about.industry' | 'about.name' | 'about.totalEmployees' | 'about.yearFounded' | 'ai.search' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.domain' | 'domain.tld' | 'finances.revenue' | 'finances.stockExchange' | 'locations.headquarters.city.code' | 'locations.headquarters.continent.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.listIds' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'socials.linkedin.id' | 'technologies.active' | 'technologies.categories' | 'urls', required - `blockedOperator` boolean - `operator` 'and' | 'or', required - `sign` 'equals' | 'exactEquals' | 'greater' | 'lower' | 'notEquals', required - `values` union[], required - union - string - number - `search` string - `searchFields` string[] - `simplified` boolean - `size` number - `sortFields` object[] - `key` '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', required - `missing` '_first' | '_last' - `order` 'asc' | 'desc', required - `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 `200` Search companies using a segmentation query. - object - `companies` CompanyV2[], required - `id` string - `about` object - `businessType` 'educational-institution' | 'government-agency' | 'nonprofit' | 'partnership' | 'privately-held' | 'public-company' | 'self-employed' | 'sole-proprietorship': The type of business the company is. - `industries` string[]: The industries the company is in. - `industry` string: The main industry of the company. - `languages` string[]: The languages the company supports. - `name` string: The name of the company. - `nameAlts` string[]: The alternative names of the company. - `nameLegal` string: The legal name of the company. - `totalEmployees` '1-10' | '10-50' | '50-200' | '200-500' | '500-1k' | '1k-5k' | '5k-10k' | 'over-10k': The total number of employees the company has. - `totalEmployeesExact` number: The exact total number of employees the company has. - `yearEnded` number: The year the company stopped its operations. - `yearFounded` number: The year the company was founded. - `yearFoundedDate` string: The date the company was founded. - `yearFoundedPlace` string: The place the company was founded. - `analytics` object - `lighthouse` object: Lighthouse and Core Web Vitals analysis. - `accessibility` number: The accessibility score (0-100). - `bestPractices` number: The best practices score (0-100). - `performance` number: The performance score (0-100). - `seo` number: The SEO score (0-100). - `maxServerLatency` number: The maximum server latency. - `numFonts` number: The number of fonts. - `numRequests` number: The number of requests. - `numScripts` number: The number of scripts. - `numStylesheets` number: The number of stylesheets. - `numTasks` number: The number of tasks. - `cumulativeLayoutShift` object: The cumulative layout shift. - `count` number - `score` number - `largestContentfulPaint` object: The largest contentful paint. - `ms` number - `score` number - `timeToInteractive` object: The time to interactive. - `ms` number - `score` number - `totalBlockingTime` object: The total blocking time. - `ms` number - `score` number - `monthlyVisitors` 'under-10k' | '10k-50k' | '50k-100k' | '100k-500k' | '500k-1m' | '1m-10m' | '10m-50m' | '50m-100m' | '100m-500m' | '500m-1b' | 'over-1b': The total number of monthly visitors the company has. - `apps` object: The apps the company owns. - `amazon` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `android` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `chrome` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `ios` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `mac` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `meta` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `microsoft` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `playstation` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `xbox` object[] - `id` string: The ID of the app. - `name` string: The name of the app. - `rating` number: The rating of the app. - `reviews` number: The number of reviews the app has. - `type` 'app' | 'developer' | 'extension': The type of app the company owns. - `url` string: The URL to the app. - `assets` object - `colorPrimary` string: The primary color of the company. - `cover` object: The cover image of the company. - `height` number: The height of the image. - `src` string: The source of the image. - `width` number: The width of the image. - `logoSquare` object: The square logo of the company. - `height` number: The height of the image. - `src` string: The source of the image. - `width` number: The width of the image. - `codes` object - `naics` string[]: The NAICS codes of the company. - `sic` string[]: The SIC codes of the company. - `companies` object - `acquisitions` object[]: The acquisitions the company has. - `description` string: The description of the acquisition. - `domain` string: The domain of the acquisition. - `name` string: The name of the acquisition. - `parent` object: The parent company of the company. - `description` string: The description of the parent company. - `domain` string: The domain of the parent company. - `name` string: The name of the parent company. - `subsidiaries` object[]: The subsidiaries the company has. - `description` string: The description of the subsidiary. - `domain` string: The domain of the subsidiary. - `name` string: The name of the subsidiary. - `contacts` object - `emails` object[]: The emails the company has. - `category` 'accounts' | 'channels' | 'general' | 'marketing' | 'reservations' | 'sales' | 'technical': The category of the contact. - `value` string: The value of the contact. - `lines` object[]: The lines the company has. - `category` 'accounts' | 'channels' | 'general' | 'marketing' | 'reservations' | 'sales' | 'technical': The category of the contact. - `value` string: The value of the contact. - `phones` object[]: The phones the company has. - `category` 'accounts' | 'channels' | 'general' | 'marketing' | 'reservations' | 'sales' | 'technical': The category of the contact. - `value` string: The value of the contact. - `whatsapps` object[]: The WhatsApp contacts the company has. - `category` 'accounts' | 'channels' | 'general' | 'marketing' | 'reservations' | 'sales' | 'technical': The category of the contact. - `value` string: The value of the contact. - `contents` object - `podcasts` object: The podcasts the company has. - `apple` object[]: The Apple podcasts the company has. - `id` string: The ID of the podcast. - `name` string: The name of the podcast. - `rating` number: The rating of the podcast. - `reviews` number: The number of reviews the podcast has. - `url` string: The URL to the podcast. - `spotify` object[]: The Spotify podcasts the company has. - `id` string: The ID of the podcast. - `name` string: The name of the podcast. - `rating` number: The rating of the podcast. - `reviews` number: The number of reviews the podcast has. - `url` string: The URL to the podcast. - `descriptions` object - `knowledgeGraph` string: The knowledge graph of the company. - `linkedin` string: The LinkedIn description of the company. - `primary` string: The primary description of the company. - `tagline` string: The tagline of the company. - `website` string: The website description of the company. - `wikipedia` string: The Wikipedia description of the company. - `domain` object - `alias` string: The alias used by the origin domain. - `createdAt` string: The date the domain was created. - `domain` string, required - `domainAlts` string[]: The alternative domains of the company. - `domainName` string: The name of the domain. - `expiredAt` string: The date the domain expired. - `nsfw` boolean: The NSFW state of the domain. - `redirection` string: The redirection of the domain. - `registrantCountry` string: The country of the registrant. - `registrantPhone` string: The phone of the registrant. - `registrar` string: The registrar of the domain. - `root` string: The root domain of the company. - `state` 'broken' | 'for-sale' | 'operating' | 'redirected': The state of the domain. - `status` number: The status of the domain. - `tld` unknown - `updatedAt` string: The date the domain was updated. - `finances` object - `revenue` 'under-1m' | '1m-10m' | '10m-50m' | '50m-100m' | '100m-200m' | '200m-1b' | 'over-1b': The total revenue the company has. - `stockExchange` string: The stock exchange the company has. - `stockSymbol` string: The stock symbol the company has. - `locations` object - `headquarters` object: The headquarters of the company. - `address` object: The address of the location. - `geopoint` object: The geopoint of the address. - `lat` number, required: The latitude of the geopoint. - `lon` number, required: The longitude of the geopoint. - `raw` string: The raw complete address. - `city` object: The city of the location. - `code` string: The code of the city. - `geopoint` object: The geopoint of the city. - `lat` number, required: The latitude of the geopoint. - `lon` number, required: The longitude of the geopoint. - `name` string: The name of the city. - `postcode` string: The postcode of the city. - `continent` object: The continent of the location. - `code` string: The code of the continent. - `geopoint` object: The geopoint of the continent. - `lat` number, required: The latitude of the geopoint. - `lon` number, required: The longitude of the geopoint. - `name` string: The name of the continent. - `country` object: The country of the location. - `code` string: The code of the country. - `geopoint` object: The geopoint of the country. - `lat` number, required: The latitude of the geopoint. - `lon` number, required: The longitude of the geopoint. - `name` string: The name of the country. - `county` object: The county of the location. - `code` string: The code of the county. - `geopoint` object: The geopoint of the county. - `lat` number, required: The latitude of the geopoint. - `lon` number, required: The longitude of the geopoint. - `name` string: The name of the county. - `state` object: The state of the location. - `code` string: The code of the state. - `geopoint` object: The geopoint of the state. - `lat` number, required: The latitude of the geopoint. - `lon` number, required: The longitude of the geopoint. - `name` string: The name of the state. - `meta` object - `ideated` boolean: If the company was ideated. - `listIds` number[]: The list ids the company is in. - `mysqlId` number: The MySQL ID of the company. - `score` number: The data score of the company, generated from the total amount of data available. - `sources` number: If the company has sources, if so how many sources. - `syncedAt` string: The date the data was last synced. - `cost` number: The cost of the company (not persisted). - `credits` number: The remaining credits of the team after requesting the company (not persisted). - `freeRequest` boolean: If the company was requested for free (not persisted). - `new` boolean: If the company is new (not persisted). - `similarAttributes` object[]: The similar attributes between the companies (not persisted). - `attribute` string, required: The similar attribute name between the companies. - `value` string, required: The similar attribute value between the companies. - `similarity` number: The similarity score between the company and the current query (not persisted). - `people` object - `secondaries` object - `emailPatterns` object[]: The email patterns the company has. - `emailsCount` number: The number of emails the pattern has. - `pattern` string: The pattern of the email. - `usagePercentage` number: The usage percentage of the pattern. - `socials` object: The social media pages of the company. - `discord` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `dribbble` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `facebook` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `facebookGroup` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `github` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `instagram` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `linkedin` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `mastodon` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `medium` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `patreon` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `pinterest` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `reddit` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `slack` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `snapchat` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `stackoverflow` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `steam` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `substack` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `threads` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `tiktok` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `tumblr` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `twitch` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `twitter` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `vimeo` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `vkontakte` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `wellfound` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `xing` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `yelp` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `youtube` object - `followers` number: The number of followers the company has. - `following` number: The number of following the company has. - `id` string: The ID of the company. - `idNumeric` string: The numeric ID of the company. - `likes` number: The number of likes the company has. - `members` number: The number of members the company has. - `monthlyViews` number: The number of monthly views the company has. - `posts` number: The number of posts the company has. - `rating` number: The rating of the company. - `reviews` number: The number of reviews the company has. - `talkingAbout` number: The number of people talking about the company. - `url` string, required: The URL to the social media page of the company. - `videos` number: The number of videos the company has. - `wereHere` number: The number of people who were here. - `technologies` object - `active` string[], required: The active company technologies. - `categories` string[], required: The categories the company technologies are in. - `details` object[], required: The details of the company technologies. - `categories` string[]: The categories of the technology. - `detectedAt` string, required: The date the technology was detected. - `detectionTypes` string[], required: The detection types the technology has. - `slug` string, required: The slug of the technology. - `version` string: The version of the technology. - `urls` object - `about` string: The URL to the about page of the company. - `blog` string: The URL to the blog of the company. - `careers` string: The URL to the careers page of the company. - `contact` string: The URL to the contact page of the company. - `crunchbase` string: The URL to the Crunchbase page of the company. - `developers` string: The URL to the developers page of the company. - `docs` string: The URL to the docs of the company. - `events` string: The URL to the events of the company. - `glassdoor` string: The URL to the Glassdoor page of the company. - `partnership` string: The URL to the partnership page of the company. - `pricing` string: The URL to the pricing page of the company. - `privacy` string: The URL to the privacy policy of the company. - `registrar` string: The URL to the registrar of the domain. - `salesNavigator` string: The URL to the Sales Navigator page of the company. - `sitemap` string: The URL to the sitemap of the company. - `status` string: The URL to the status page of the company. - `terms` string: The URL to the terms of service of the company. - `updates` string: The URL to the updates of the company. - `website` string: The URL to the website of the company. - `wellfound` string: The URL to the Wellfound page of the company. - `wikidata` string: The URL to the Wikidata page of the company. - `wikipedia` string: The URL to the Wikipedia page of the company. - `vectors` object - `global` number[]: The global computed vector. - `action` object: The action results for the company. - `answer` object: The answer of the action. - `explanation` string: The explanation of the answer. - `output` object: The output of the answer. - `score` number: The score of the answer. - `meta` PaginationMeta, required: Metadata about a paginated or billed response. - `cost` number, required - `credits` number, required - `currentPage` number, required - `firstPage` number, required - `freeRequest` boolean, required - `lastPage` number, required - `maxScrollResultsReached` boolean - `perPage` number, required - `total` number, required - `query` SegmentationCondition[], required - `attribute` 'about.businessType' | 'about.industries' | 'about.industry' | 'about.name' | 'about.totalEmployees' | 'about.yearFounded' | 'ai.search' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.domain' | 'domain.tld' | 'finances.revenue' | 'finances.stockExchange' | 'locations.headquarters.city.code' | 'locations.headquarters.continent.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.listIds' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'socials.linkedin.id' | 'technologies.active' | 'technologies.categories' | 'urls', required - `blockedOperator` boolean - `operator` 'and' | 'or', required - `sign` 'equals' | 'exactEquals' | 'greater' | 'lower' | 'notEquals', required - `values` union[], required - union - string - number ## Other responses - `401`: The error message - `403`: The error message --- [API](https://skmtc.dev/thecompaniesapi/apis/the-companies-api.md) - [All operations](https://skmtc.dev/thecompaniesapi/apis/the-companies-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thecompaniesapi/apis/the-companies-api/revisions/f8bfc2d10b71?raw)