Skip to main content
GET
Get Database Filters
Please, note that:
  • you will not be able to use a filter for a People database query if the leads keyword is not listed in the mode property
  • you will not be able to use a filter for a Companies database query if the companies keyword is not listed in the mode property
  • to build a saved search, call this endpoint with usage=ui: saved searches refuse the filters that are not usable in the People Database UI

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

usage
enum<string>
default:api

Context the filters will be used in. api (default) lists the filters accepted by the search endpoints. ui lists the filters usable in the People Database UI: use it to pick the filters of a saved search, which refuses the others.

Available options:
api,
ui
mode
enum<string>

Restrict the list to the filters of one search mode

Available options:
leads,
companies

Response

Success

filterId
string
required

Filter identifier, to send as filterId in the search filters

Example:

"department"

description
string
required

Human-readable filter name, followed by a description of what the filter matches when one exists

Example:

"Department: Filter by the lead's department (e.g. 'Sales', 'Marketing', 'Engineering', 'Finance / Legal / Admin', 'Human Resources'). Use to target a functional buyer persona regardless of the exact job title."

type
enum<string>
required

Kind of input the filter expects. level is a two-level dropdown of the People Database UI; it is reported as select by default.

Available options:
text,
select,
autocomplete,
static,
slider,
level,
elasticId
Example:

"select"

mode
enum<string>[]

Search modes the filter can be used in: leads for Search People Database, companies for Search Companies Database. Omitted when the request is scoped to a single mode.

Available options:
leads,
companies
Example:
values
string[]

Allowed values, for the filters that have a fixed list

Example:
range
object

Slider configuration, for the slider filters