Skip to main content
GET
Get Filters List

Overview

The Get Filters List API returns every filter accepted by the List Generation API — its key, the shape its value must take, a description, and whether its values must be looked up from the Get Filter Options API or supplied directly. This is a free endpoint and does not consume credits. It takes no parameters. Results are returned in the API response.

Endpoint Details

  • Method: GET
  • Endpoint: /api/v1/filters/list/

Authentication requirements

  • Include a valid API key in the x-api-key request header.

Request

Request Parameters

Header Parameters

string
required
Your API key.
This endpoint takes no query or body parameters.

Response

Successful Response Fields

Returns a JSON object with the following structure:
integer
Total number of filters returned.
string
A short guide describing how to use these filters with the Get Filter Options and List Generation APIs, and how same_element_group works.
array
Array of filter objects. See Filter Object below.

Filter Object

string
The exact key to use inside filters when calling the List Generation API. Matches the field’s path in the enrichment document. Example: firmographic.company_type.
string
The type and shape the filter’s value must take. Examples: string, list[string], bool, int | list[int], or a range object such as {"gte": int, "lte": int}.
string
What the filter matches, plus any usage notes — including when to prefer one related filter over another.
string
Either "look up with /list/options/" or "supply the value directly".
string
Present only when how_to_get_values is "look up with /list/options/". Pass this exact string as the dropdown_type in a Get Filter Options request.
string
Present only on filters over a nested array (offices, funding rounds, partnerships, markets served). Filters sharing the same same_element_group value must all match the same array element on a given company.

Authorizations

x-api-key
string
header
required

API key obtained from your Akta account.

Response

Filters list returned

count
integer

Total number of filters returned.

usage
string

Short guide describing how to use these filters with the Get Filter Options and List Generation APIs.

filters
object[]
credits_consumed
number<float>
Example:

0