--- title: "Search" method: POST path: "/api/v1.4/search/" tags: ["search"] --- # Search `POST /api/v1.4/search/` Returns Grata-powered search results based on an input search query. ## Request body - SearchFilters - `terms_include` object - `groups` object[] - `terms` string[] - `terms_operator` 'any' | 'all' - `terms_depth` 'core' | 'mention' - `group_operator` 'any' | 'all' - `terms_exclude` string[] - `page_token` string — Page token used for pagination. - `lists` object — Grata list IDs to search within. - `include` string[] - `exclude` string[] - `industry_classifications` object — Industry classification codes. - `include` number[] - `exclude` number[] - `end_customer` string[] - `ownership` string[] - `business_models` string[] - `is_funded` boolean — Indicates whether the company has received outside funding. - `funding_size` number[] - `funding_stage` string[] - `employees_change_time` 'month' | 'quarter' | 'six_month' | 'annual' - `grata_employees_estimates_range` number[] - `employees_on_professional_networks_range` number[] - `employees_change` number[] - `year_founded` number[] - `headquarters` object - `include` object[] - `city` string - `state` string - `country` string - `exclude` object[] - `city` string - `state` string - `country` string ## Response `200` OK - SearchResponse - `count` integer, required — Total number of items. - `page_token` string, required — Token for pagination. - `companies` Company[], required - `name` string, required — Name of the company. - `company_uid` string, required — Unique alphanumeric Grata ID for the company (case-sensitive). - `url` string — URL to the company's Grata profile. - `domain` string — Domain of the company. - `description` string — Description of the company. - `domains` Domain[] — Associated domains for the company. Includes foreign domains, secondary domains, and redirects. - `domain` string, required — Domain of a company. - `status` number, required — Indicates if this domain is active. 0 indicates an active domain, 1 indicates an inactive domain. - `domain_type` 'Primary' | 'Product' | 'Business unit' | 'Redirect' | 'Foreign language' | 'Corporate' | 'Blog' | 'Blacklisted domain' | 'Secondary', required — The type of domain. - `is_active` string — Indicates if this company is active in platform. - `headquarters` string — City and region of headquarters. - `locations` Locations — Locations of business. - `locations` Location[], required — List of locations. - `location_type` string — Indicates if the location is the HQ or location of business. - `city_name` string, required — Name of the city of the location. - `continent_name` string — Name of the continent of the location. - `country_iso2` string, required — Two-digit country abbreviation. - `country_iso3` string — Three-digit country abbreviation. - `country_name` string — Name of the country for the location. - `house_number` string — House number for the location. - `latitude` number — Latitude for the location. - `longitude` number — Longitude for the location. - `macro_region` string — Macro region for the location. - `micro_region` string — Micro region for the location. - `postal_code` string — Postal code of location. - `raw_address` string — The location's full address. - `region_iso` string — Region abbreviation of the location. - `region_name` string — Name of the region for the location. - `street` string — Street name of the location. - `greater_regions` object[] — List of the greater regions encompassing the location. - `name` string — Name of the greater region. - `total` integer, required — Total count of all locations of business for the Company - `revenue_estimates` number — Grata's revenue estimate - `grata_employee_estimates` integer — Grata's employee estimates - `employee_location_breakdown` EmployeeLocation[] — Location breakdown of the employees by country - `country` string, required — Country where the employees are located. - `country_percentage` number, required — Percentage of the employees located in the specified country. - `confidence` string, required — Confidence score of the prediction. - `employees_on_professional_networks` integer — The number of employees on professional networks. - `employees_growth` EmployeeGrowth — Employee growth rate as a percentage. - `percentage_one_month` number, required — 1 month growth rate as a percentage. - `percentage_three_month` number, required — 3 month growth rate as a percentage. - `percentage_six_month` number, required — 6 month growth rate as a percentage. - `percentage_one_year` number, required — Annual growth rate as a percentage. - `primary_phone` string — Primary company phone number from home page or contact section of the website. - `primary_email` string — Primary company email from home page or contact section of the website. - `social_linkedin` string — Link to the company's LinkedIn page. - `social_facebook` string — Link to the company's Facebook page. - `social_twitter` string — Link to the company's Twitter page. - `social_instagram` string — Link to the company's Instagram page. - `social_crunchbase` string — Link to the company's Crunchbase page. - `ownership_status` 'Bootstrapped' | 'Investor Backed' | 'Public Subsidiary' | 'Public' | 'Private Subsidiary' | 'Private Equity Add-On' | 'Private Equity' — Current ownership status of the company. - `entity_type` 'Event' | 'Private' | 'Public' | 'Government' | 'Industry Organization' | 'Non-Profit' | 'Private Equity' | 'Subsidiary' — The company's entity classification. - `owner` Owner — Owner information. - `id` string, required — Platform ID for the owner. - `name` string, required — Name of the owner. - `domain` string — Domain of the owner. - `status` string — Platform status of the owner. - `ultimate_owner` Owner — Owner information. - `id` string, required — Platform ID for the owner. - `name` string, required — Name of the owner. - `domain` string — Domain of the owner. - `status` string — Platform status of the owner. - `ultimate_entity_type` 'Event' | 'Public' | 'Private' | 'Government' | 'Industry Organization' | 'Non-Profit' | 'Private Equity' | 'Subsidiary' — Ultimate owner company type. - `organization_type` 'Company' | 'Independent' | 'Private Equity' | 'Public Subsidiary' | 'Private Subsidiary' | 'Private Equity Add-On' | 'Private Equity Platform' — The type of organization. - `year_founded` integer — Founding year of the company. - `funding_stage` 'Early Stage Funding' | 'Late Stage Funding' | 'Pre-IPO Funding' | 'Private Equity Backed' | 'Other Funding' | 'Public' — Stage of funding a company has received. - `latest_funding_date` string, date — The date of the last funding round. - `latest_funding_amount` number — The last funding amount received. - `latest_funding_round` string — The type of the last funding round. - `total_funding` number — The total funding amount received. - `funding_rounds_count` integer — Rounds of equity funding the company has received. - `keywords` string[] — Top 10 most relevant keywords that relate to the company's operations. - `end_customer` string[] — End vertical that the company sells to. - `business_models` string[] — Method of product or service delivery. - `classifications` Classifications — Classifications for the company. - `industry_classifications` IndustryClassification[], required — Industry classifications for the company. - `industry_code` string, required — Industry code. - `industry_name` string, required — Industry name. - `software_industries` SoftwareIndustry[], required — Software industry classifications for the company. - `industry_code` string, required — Software industry code. - `industry_name` string, required — Software industry name. - `conferences` Conferences — Conferences the company has or will attend. - `conferences` Conference[], required — List of conferences. - `name` string, required — Name of the conference. - `company_count` integer, required — Total count of companies attending the conference. - `start_date` string, date, required — Start date of the conference (YYYY-MM-DD). - `end_date` string, date, required — End date of the conference (YYYY-MM-DD). - `url` string, required — Link to the conference. - `location` string, required — Location of the conference. - `count` integer, required — Total count of all conferences. - `contacts` Contacts — Contacts for the company. - `contacts` Contact[], required — List of contacts. - `name` string, required — Name of the contact. - `title` string, required — Title of the contact. - `work_email` string, required — Work email of the contact. - `email_deliverability` string — Email Deliverability of the contact's email. - `socials_linkedin` string — Link to the contact's LinkedIn page. - `socials_twitter` string — Link to the contact's Twitter page. - `socials_facebook` string — Link to the contact's Facebook page. - `age` integer — Age of contact. - `count` integer, required — Total count of all contacts. - `investors` union - string - Investors — Investors of the company. - `id` string, required — Platform ID for the investor. - `name` string, required — Name of the investor. - `domain` string, required — Domain of the investor. ## Other responses - `400` — Bad Request. Incorrect request body. - `401` — Unauthorized. API key is invalid. - `404` — Not Found. - `429` — Too Many Requests. Rate limit exceeded. - `500` — Internal Server Error. An error occurred with our API. --- [API](https://skmtc.net/tjc-lp/apis/grata-unified-api.md) · [All operations](https://skmtc.net/tjc-lp/apis/grata-unified-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tjc-lp/grata-unified-api/versions/d78ed69a85eb/schema)