Skip to main content
Before building a contact search request, use these filter endpoints to retrieve the exact values the API accepts. Passing unrecognized values causes searches to return no results, so fetching valid options first is the recommended approach. All filter values returned here are intended for use in POST /prospecting/contact/search.

​
Available filter endpoints

​
How to use these endpoints

The typical workflow is to call a filter endpoint, pick the values you want, and pass them directly into your search request body.
1

Fetch valid filter values

Call the filter endpoint for the dimension you want to filter on. For example, to get the list of departments:
The response is a bare array of valid department values:
2

Pick the values you need

Select the values that match your ideal customer profile. For example: "Engineering".
3

Pass them into your search request

Nest the selected values under filters.contacts.include in POST /prospecting/contact/search:
Seniority is filtered by the numeric id values returned by the seniority filter endpoint, not by name strings.
The locations endpoint accepts a text query in the text field and returns matching location objects you can use in your search. This is useful when you want to target a specific city or region and need the exact values the API recognizes.

​
Endpoint details

​
GET /prospecting/filters/contacts/departments

Returns the list of departments available for filtering contacts.

​
GET /prospecting/filters/contacts/seniority

Returns all seniority levels as {id, name} objects (e.g., founder, c-suite, vice president). Filter by the numeric id values.

​
GET /prospecting/filters/contacts/existing_data_points

Returns available data point types you can require to be present on returned contacts (e.g., work_email, phone, direct_phone).

​
GET /prospecting/filters/contacts/all_countries

Returns the full list of countries available for contact location filtering. There is no standalone countries filter field - use the country values returned here inside a locations entry (see Location search).

​
POST /prospecting/filters/contacts/locations

Searches for location objects by free-text query. Use the returned objects (or the fields you need from them) in your search request.
Cache responses from the GET filter endpoints. Department, seniority, country, and data point values rarely change and do not need to be fetched on every search run.