Skip to main content
POST
Create a saved search

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Body

application/json
name
string
required

Display name of the saved search.

Example:

"VP Engineering in SF"

type
enum<string>
required

Entity type the search targets.

Available options:
contacts,
companies
Example:

"contacts"

values
object
required

Search filters, under the same names POST /search/contacts and POST /search/companies accept, matching the saved search type. Filters the search endpoints do not accept are stored as sent and ignored when the search runs. A location that matches no known place is rejected. Intent filters are dropped.

sortColumn
string

Column used to sort results. Stored as sent.

sortOrder
string

Sort direction. Stored as sent.

Example:

"desc"

tagIds
integer[]

IDs of lists to link to the saved search. Numeric strings are accepted.

numResultsApproved
integer
default:0

Result count to store. When 0 or omitted, the search is run and its total is stored instead.

Required range: x >= 0
Example:

50

Response

The created saved search.

success
boolean
Example:

true

data
object