List prospector companies
Retrieve a paginated list of prospector-discovered companies.
Request
- Base URLhttps://api.commonroom.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The maximum number of companies to return per page
Pagination cursor from a previous response
Comma-separated list of additional columns to include in the response. Valid column values: description, employees, linkedInHandles, location, logoUrl, primaryWebsite, raised, revenueRange, subIndustry, technologies. The meta column recordCount can be requested to return the total number of matching companies in meta.recordCount.
Structured filter as URL-encoded JSON — see the LightFilterExpression schema for the grammar. Conditions are combined (AND) with the other query parameters.
Filterable fields:
| Field | Filter type | Operators | Description |
|---|---|---|---|
| groupName | stringFilter | eq, like | Filter prospector companies by name. |
| groupLinkedinHandle | stringListFilter | any, none | Filter prospector companies by LinkedIn handle. |
| groupWebsite | stringFilter | eq, like | Filter prospector companies by primary website/domain (e.g., "acme.com"). |
| groupSubIndustry | stringListFilter | any, none, empty, notEmpty | Filter prospector companies by industry label (e.g. "Software", "Healthcare"). Not to be confused with groupIndustryCode which filters by NAICS code. |
| groupCompanySize | numberFilter | eq, ne, gte, lte | Filter prospector companies by employee count. |
| groupRevenue | numberFilter | gt, gte, lt, lte | Filter prospector companies by estimated annual revenue. Lower bounds match the estimate's floor, upper bounds its ceiling. |
| groupCapitalRaised | numberFilter | eq, ne, gt, gte, lt, lte | Filter prospector companies by total capital raised. |
| groupLocationId | stringListFilter | any, all, none, empty, notEmpty | Filter prospector companies by location ID(s). Use location IDs from GET /locations. |
| groupIndustryCode | stringListFilter | any, all, none, empty, notEmpty | Filter prospector companies by NAICS industry code. Discover codes via GET /industries. Values are numeric strings (e.g. "517", "5112"). Not to be confused with groupSubIndustry which filters by industry label. |
| groupTechStackId | stringListFilter | any, all, none | Filter prospector companies by tech stack product ID(s). Look up product IDs via GET /tech-stack-products. |
| technographicsIntensity | numberFilter | gte, lte | Filter prospector companies by technology usage intensity score. |
| technographicsFirstSeen | dateRangeFilter | in, between, after, before | Filter prospector companies by when a technology was first detected. |
| technographicsLastSeen | dateRangeFilter | in, between, after, before | Filter prospector companies by when a technology was last detected. |
| jobOpeningKeyword | stringListFilter | any, all, none | Filter companies by job listing keyword search. Finds companies with job openings matching the given keywords. |
| jobOpeningTitle | stringListFilter | any, all, none | Filter companies by job listing title. |
| jobOpeningStatus | stringFilter | eq | Filter companies by job opening status. Values: 'open', 'closed'. |
| jobOpeningSeniority | stringListFilter | any, none | Filter companies by job seniority level. Values: owner, founder, c_level, partner, president, vice_president, head, director, manager, non_manager, mid_senior, junior. |
| jobOpeningFirstSeen | dateRangeFilter | in, between, after, before | Filter companies by the date a job opening was originally published or first discovered. |
| jobOpeningLastSeen | dateRangeFilter | in, between, after, before | Filter companies by the most recent date a job opening was still observed as active. Use this to find companies whose listings are currently live or were recently open. |
| jobOpeningGeolocation | stringListFilter | any, none | Filter prospector companies by job opening location ID(s). Use location IDs from GET /locations. |
| newsKeyword | stringListFilter | any, all, none | Filter companies by news keyword search. Finds companies with news articles matching the given keywords. |
| newsCategory | stringListFilter | any, none | Filter companies by news category. Values: hires, promotes, leaves, acquires, merges_with, launches, receives_financing, partners_with, expands_offices_to, and more. |
| newsPublishedAt | dateRangeFilter | in, between, after, before | Filter companies by news publication date. |
Filtering by a related entity: a group whose target names another entity applies its clauses to that entity, using the fields of that entity's list endpoint. Every group must send target, objectConfigId and targetAssocPaths, using null for any it doesn't use. Targets this endpoint accepts:
| Target | Matches companies | Clauses use |
|---|---|---|
| ProspectorCompany | that match the clauses, the same as no target | the fields above |
| ProspectorContact | with at least one matching contact | GET /prospector-contacts fields |
Any other target returns a 400.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.