Skip to main content
POST
Create a saved search

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Body

application/json
title
string
required

The saved search's title. Titles need not be unique, but a shared title cannot be run by name.

Required string length: 1 - 255
Example:

"Portugal freight ops"

filters
object
required

The search's filters, as the people or company search takes them, such as the filters a search page answered with.

Example:
type
enum<string>
default:people

The kind of search the filters are for. It cannot change later.

Available options:
people,
company

Response

The saved search.

id
string
required
title
string
required
type
enum<string>
required

The kind of search the filters are for.

Available options:
people,
company
filters
object
required
createdAt
string<date-time>
required
ignoredFilterKeys
string[]

Stored filters the search no longer takes, which are left out when it runs.

updatedAt
string<date-time>

Absent until it is first changed.