> ## Documentation Index
> Fetch the complete documentation index at: https://agent-docs.akta.pro/llms.txt
> Use this file to discover all available pages before exploring further.
# Filter Options API
> Returns the available options for one or more specific List Generation filter fields.
## Overview
The Get Filter Options API returns the selectable values for one or more filter fields, given a list of `dropdown_type` names. Pass the filter field names — the same `field` values returned by the Get Filters List API — and get back the options available for each one. This is a free endpoint and does not consume credits. Results are returned in the API response.
## Endpoint Details
* **Method:** POST
* **Endpoint:** `/api/v1/filters/options/`
## Authentication requirements
* Include a valid API key in the `x-api-key` request header.
## Request
### Request Parameters
#### Header Parameters
Your API key.
#### Body Parameters
Array of objects, one per filter you want options for. Each object has a single `dropdown_type` key — a filter field name from the Get Filters List API (e.g. `firmographic.company_type`).
To fetch options for every filter in one call, pass one object per filter field:
```json theme={null}
{
"dropdowns": [
{"dropdown_type": "firmographic.company_type"},
{"dropdown_type": "firmographic.ownership_category"},
{"dropdown_type": "firmographic.operating_status"},
{"dropdown_type": "funding_detail.funding_overview.funding_stage"},
{"dropdown_type": "financial_estimate.revenue_estimate"},
{"dropdown_type": "financial_estimate.valuation_estimate"},
{"dropdown_type": "location.hq.region"},
{"dropdown_type": "location.hq.country"},
{"dropdown_type": "business_model.gtm_type"},
{"dropdown_type": "business_model.gtm_motion"},
{"dropdown_type": "business_model.offering_type"},
{"dropdown_type": "company_assessment.customer_concentration.classification"},
{"dropdown_type": "technology.ai_maturity.scale"},
{"dropdown_type": "business_model.revenue_model"},
{"dropdown_type": "company_assessment.competitive_moat"},
{"dropdown_type": "location.market_served.markets.country"},
{"dropdown_type": "location.offices.country"},
{"dropdown_type": "strategic_signal.partnership.type"}
]
}
```
#### Example Request
```text theme={null}
POST /v1/filters/options
x-api-key:
Content-Type: application/json
{"dropdowns":[{"dropdown_type":"firmographic.company_type"}]}
```
## Response
#### Successful Response Fields
Returns a JSON object with the following structure:
Options keyed by the `dropdown_type` requested. Each value is an array of option objects for that filter. See **Option Object** below.
Credits consumed by the request. This endpoint is free and always returns `0.00`.
#### Option Object
The value to pass in `filters` when calling the List Generation API.
Human-readable label for the value, suitable for displaying in a UI dropdown.
```json 200 expandable wrap theme={null}
{
"data": {
"firmographic.company_type": [
{ "value": "private", "label": "Private" },
{ "value": "public", "label": "Public" }
]
},
"credits_consumed": 0.00
}
```
## OpenAPI
```yaml POST /v1/filters/options theme={null}
openapi: 3.0.3
info:
title: Akta.pro API
version: 1.0.0
contact:
url: https://akta.pro
servers:
- url: https://api.akta.pro/api
description: Production server
security: []
tags:
- name: List Generation
description: Build targeted company lists using structured filters
paths:
/v1/filters/options:
post:
tags:
- List Generation
summary: Get Filter Options
description: >
Returns the available options for one or more specific List Generation
filter fields, given a list of dropdown_type names.
This is a free endpoint — it does not consume API credits.
operationId: getFilterOptions
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- dropdowns
properties:
dropdowns:
type: array
items:
type: object
required:
- dropdown_type
properties:
dropdown_type:
type: string
description: A filter field name, as returned by the Get Filters List API.
example:
dropdowns:
- dropdown_type: firmographic.company_type
responses:
'200':
description: Filter options returned
content:
application/json:
schema:
type: object
properties:
data:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/FilterOption'
credits_consumed:
type: number
format: float
example: 0
'400':
description: Bad request — missing or malformed dropdowns array.
'401':
description: Unauthorized — missing or invalid API key.
security:
- xApiKeyAuth: []
components:
schemas:
FilterOption:
type: object
properties:
value:
type: string
description: The value to pass in `filters` when calling the List Generation API.
label:
type: string
description: Human-readable label for the value.
securitySchemes:
xApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: API key obtained from your Akta account.
```
## OpenAPI
````yaml POST /v1/filters/options/
openapi: 3.0.3
info:
title: Akta.pro API
description: >
Akta provides APIs for company intelligence and news monitoring:
1. **News** – Enriched news articles with AI summaries, sentiment, event
tags, industry classifications, and company mention resolution.
2. **Company Enrichment** – Structured company data including firmographics,
funding, headcount, and financials.
3. **Company Search** – Free endpoint to resolve company names, domains, or
UUIDs.
4. **Product Reviews** – G2 product reviews with ratings and review content.
5. **Employee Reviews** – Employee sentiment data with workplace ratings.
**Authentication:** All endpoints require an API key in the `x-api-key` HTTP
header.
version: 1.0.0
contact:
url: https://akta.pro
servers:
- url: https://api.akta.pro/api
description: Production server
security: []
tags:
- name: News
description: Enriched news articles with AI summaries, sentiment, and company mentions
- name: Company
description: Company data enrichment, search, and addition
- name: Reviews
description: Product and employee reviews from external sources
- name: Supporting APIs
description: Utility endpoints for request tracking
- name: List Generation
description: >-
Build targeted company lists using structured filters or natural language
queries
externalDocs:
description: Official Akta.pro API Documentation
url: https://docs.akta.pro
paths:
/v1/filters/options/:
post:
tags:
- List Generation
summary: Get Filter Options
description: >
Returns the available options for one or more specific List Generation
filter fields, given a list of `dropdown_type` names. Pass the filter
field names — the same `dropdown_type` values returned by the Get
Filters List API — and get back the options available for each one. This
is a free endpoint and does not consume credits.
Results are returned in the API response.
operationId: getFilterOptions
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- dropdowns
properties:
dropdowns:
type: array
items:
type: object
required:
- dropdown_type
properties:
dropdown_type:
type: string
description: >-
A filter field name, as returned by the Get Filters
List API (e.g. 'firmographic.company_type').
description: >-
Array of filter fields to look up. Each object has a single
`dropdown_type` key.
responses:
'200':
description: Filter options returned
content:
application/json:
schema:
type: object
properties:
data:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/FilterOption'
description: >-
Options keyed by the `dropdown_type` requested. Each value
is an array of option objects for that filter.
credits_consumed:
type: number
format: float
example: 0
'400':
description: Bad request — missing or malformed dropdowns array.
'401':
description: Unauthorized — missing or invalid API key.
security:
- xApiKeyAuth: []
components:
schemas:
FilterOption:
type: object
properties:
value:
type: string
description: The value to pass in `filters` when calling the List Generation API.
label:
type: string
description: >-
Human-readable label for the value, suitable for displaying in a UI
dropdown.
securitySchemes:
xApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: API key obtained from your Akta account.
````