> ## Documentation Index > Fetch the complete documentation index at: https://developers.dealroom.co/llms.txt > Use this file to discover all available pages before exploring further. # List filters > Returns available filters for the given scope with category grouping, operators, and optional user-facing descriptions and examples. Valid scopes: companies, investors, transactions, people, universities, news, jobs. ## OpenAPI ````yaml /mintlify/openapi.yaml get /api/reference/filters openapi: 3.1.0 info: title: Dealroom API version: '2026-07-06' description: >- REST API for the Dealroom platform — companies, funds, founders, investors, funding rounds, valuations, taxonomy, news, and aggregate analytics across all of them. Authentication uses Auth0 (Bearer JWT or OAuth2 client_credentials). All endpoints are versioned via the `API-Version` header (Stripe-style date-based versioning). contact: name: Dealroom API support email: support@dealroom.co url: https://dealroom.co termsOfService: https://dealroom.co/terms license: name: Proprietary — Dealroom commercial license url: https://dealroom.co/terms servers: - url: https://api-next.dealroom.co description: Production - url: https://api-next.beta.dealroom.co description: Beta - url: https://api-next.staging.dealroom.dev description: Staging security: - bearerAuth: [] - oauth2: [] tags: - name: Discovery description: API root discovery and functional namespaces. - name: Entities description: >- Companies, investors, people, universities, and other organisations. Filter, sort, and paginate the unified entity index. The term `investor` refers to the investment firm; `fund` refers to the capital vehicle it raises. - name: Companies description: >- Company profiles — the `organization_subtype = company` subset of entities (excludes investors, universities, and gov/NGOs). Same response shape as the entity index, scoped to companies. - name: Universities description: >- University profiles — the `organization_subtype = university` subset of entities. The `university` sub-object carries alumni metrics. - name: Government & NGO description: >- Government bodies and NGOs — the `organization_subtype = gov_ngo` subset of entities. - name: Transactions description: >- Funding rounds, equity events, debt, grants, exits, and other company-level financial events. - name: Valuations description: Company valuation history by year and month. - name: Investors description: >- Investor profiles (VCs, corporates, angels, family offices, governments). Subset of entities where `is_investor = true`. An investor is the firm that makes investments; the capital vehicles it raises are funds available via `/investors/{id}/funds`. - name: Funds description: >- Funds — the capital vehicles investor firms raise (e.g. "Fund III", $200M, 2024). Browse/filter by manager, type, size, and vintage; each fund links to its manager (GP). Fund size (`amount`) converts to the requested `?currency=` (default USD); `amount_source` carries the original native-currency amount. - name: People description: >- Person profiles (founders, executives, angels, and others). Subset of entities where `entity_type = 'person'`. Same response shape as founders, with company associations, education, and backgrounds. - name: Founders description: >- Founder profiles with company associations and education history. Subset of entities where `is_founder = true`. - name: News description: Curated news articles about companies, funds, deals, sectors, and events. - name: Jobs description: Active job openings posted by companies, with hiring-trend signals. - name: Aggregate description: >- Composable single- and multi-metric aggregations across companies, funding rounds, valuations, founders, and investors. - name: Funding Analytics description: 'Purpose-built analytics: 2D heatmaps, round transitions, capital funnels.' - name: Timeseries description: Yearly entity metrics (employees, revenue, valuation). - name: Matching description: >- Investor matching tool: ranked investor recommendations for a given deal profile. - name: Filters description: >- Filter registry discovery and value lookup. Use `/api/reference/filters` to discover available filters per scope and `/api/reference/filters/:key/values` to look up valid values. - name: Account description: User profile, authentication introspection, and account settings. - name: API Keys description: >- Self-service API key management. Programmatic (M2M) keys for server-side and Application (PKCE) keys for browser SPAs. - name: Teams description: Team membership and invitation management. - name: Usage description: Request-count usage analytics per API key for billing and introspection. - name: Metrics description: >- Service observability metrics (OpenTelemetry configuration and runtime counters). - name: Health description: Liveness probe (public, unauthenticated). - name: Search description: >- Cross-resource fuzzy search across companies, investors, people, universities, and government & NGO bodies. - name: Ecosystems description: >- Curated entity collections that can be filtered, navigated, and compared. Includes nested landscape resources. - name: Landscapes description: Saved entity lists within an ecosystem (e.g. "top fintech in NL"). - name: Enhancement Requests description: User-submitted profile data corrections routed to Dealroom Data Support. paths: /api/reference/filters: get: tags: - Filters summary: List filters description: >- Returns available filters for the given scope with category grouping, operators, and optional user-facing descriptions and examples. Valid scopes: companies, investors, transactions, people, universities, news, jobs. operationId: filters parameters: - schema: type: string enum: - companies - investors - transactions - people - universities - news - jobs description: >- Required. One of: companies, investors, transactions, people, universities, news, jobs example: companies required: true name: scope in: query responses: '200': description: Available filters with category metadata content: application/json: schema: $ref: '#/components/schemas/FiltersResponse' example: data: - key: tag_id label: Tags description: >- Find companies by sector, industry, technology, or other tags. description_long: >- Use tags to narrow companies by Dealroom's taxonomy. Combine multiple tag IDs with multi-value operators. examples: - value: 42 label: Fintech - value: 123 label: Climate type: id_lookup category: Sectors operators: - eq - neq - in_any - in_all - nin_any - nin_all supports_type_filter: true sub_types: - key: industry label: Industries - key: technology label: Technologies - key: sector label: Sectors - key: launch_date label: Founded Year type: date category: Company Info operators: - gte - lte - between - key: is_vc_backed label: VC Backed type: boolean category: Funding operators: - eq '401': description: >- Authentication required. The `Authorization` header was missing, the bearer token was malformed, or the token failed signature / expiry validation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Authentication succeeded but the caller's token does not include the permission required for this operation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - oauth2: - read:dimensions - bearerAuth: - read:dimensions components: schemas: FiltersResponse: type: object properties: data: type: array items: type: object properties: key: type: string filter_key: type: string pinned_sub_type: type: string label: type: string description: type: string description_long: type: string examples: type: array items: type: object properties: value: anyOf: - type: string - type: number - type: boolean label: type: string required: - value type: type: string enum: - id_lookup - enum - boolean - numeric - date - text category: type: string operators: type: array items: type: string format: type: string enum: - currency - year - count supports_type_filter: type: boolean sub_types: type: array items: type: object properties: key: type: string label: type: string required: - key - label data_status: type: object properties: kind: type: string enum: - stub - data-incomplete - unloaded - partial reason: type: string gap_id: type: string required: - kind - reason - gap_id description: >- Present only when the filter is not fully functional today. See `docs/api-gaps.md` for the full registry. required: - key - filter_key - label - type - category - operators required: - data ErrorResponse: type: object properties: error: type: object properties: code: type: string message: type: string details: anyOf: - type: array items: type: object properties: path: type: string message: type: string required: - path - message - type: object additionalProperties: anyOf: - type: string - type: number - type: boolean required: - code - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Auth0 JWT access token. Paste a token obtained from your preferred OAuth2 flow. For machine-to-machine use, the OAuth2 client_credentials scheme below can mint a token directly from your `client_id` / `client_secret` inside the Swagger UI Authorize dialog. oauth2: type: oauth2 description: >- OAuth2 client-credentials flow against the Dealroom Auth0 tenant. Use the `client_id` / `client_secret` from a Programmatic API key. Tokens are valid for 24h — Swagger UI will reuse the same token across operations. flows: clientCredentials: tokenUrl: https://accounts.dealroom.co/oauth/token scopes: read:entities: Grant the read:entities permission read:transactions: Grant the read:transactions permission read:valuations: Grant the read:valuations permission read:investors: Grant the read:investors permission read:founders: Grant the read:founders permission read:dimensions: Grant the read:dimensions permission read:timeseries: Grant the read:timeseries permission read:aggregate: Grant the read:aggregate permission read:funding-analytics: Grant the read:funding-analytics permission read:ecosystems: Grant the read:ecosystems permission write:ecosystems: Grant the write:ecosystems permission delete:ecosystems: Grant the delete:ecosystems permission write:landscapes: Grant the write:landscapes permission delete:landscapes: Grant the delete:landscapes permission read:metrics: Grant the read:metrics permission create:api-keys: Grant the create:api-keys permission read:api-keys: Grant the read:api-keys permission delete:api-keys: Grant the delete:api-keys permission admin:api-keys: Grant the admin:api-keys permission read:usage: Grant the read:usage permission read:news: Grant the read:news permission read:jobs: Grant the read:jobs permission read:people: Grant the read:people permission read:teams: Grant the read:teams permission write:teams: Grant the write:teams permission delete:teams: Grant the delete:teams permission manage:team-members: Grant the manage:team-members permission read:search: Grant the read:search permission write:ai-features: Grant the write:ai-features permission ````