Skip to main content
POST
Save a lead search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A search worth keeping: the filters plus a name to find them by.

name
string
required
Required string length: 1 - 255
record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
companies
CompanyQuerySchema · object | null

Filters for a company search.

description
string | null
Maximum string length: 2000
people
PeopleQuerySchema · object | null

Filters for a people search.

row_limit
integer | null
Required range: 1 <= x <= 250000

Response

Successful Response

A saved search, in the request's own shape for lossless rehydration.

created_at
string<date-time>
required
created_by_user_id
string
required
description
string | null
required
id
string<uuid>
required
last_used_at
string<date-time>
required
name
string
required
query
Query · object
required
record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
row_limit
integer | null
required