THthecompaniesapi

companies

GET /v2/companies/by-prompt

Search companies by prompt.

Request

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

Query parameters

listsToExcludestring

pagenumber

promptstring required

similaritynumber

simplifiedboolean

sizenumber

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

Search companies by prompt.

Changes

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