Skip to main content
POST
Replay a saved search

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

savedSearchId
string
required

Id of the saved search (24-character hex ObjectId), as returned by GET /saved-searches.

Body

application/json

Optional paging and lookup overrides for the replay — size, scrollToken, linkedinUrl — or no body at all. The stored filters are the search; any other key, filters included, is rejected with 422 VALIDATION_FAILED.

size
integer
default:10

Profiles per page (1-100, default 10); the search pre-checks 1 credit per requested profile and debits 1 credit per profile returned.

Required range: 1 <= x <= 100
scrollToken
string

The scrollToken returned by the previous page, sent together with the same filter source, to fetch the next page. A token this API did not issue answers 422 SCROLL_TOKEN_INVALID: start again without it.

linkedinUrl
string

A LinkedIn profile URL (or in/<slug>, or the bare slug) to look up one person, normalised before matching; counts as search criteria on its own. A value that names no profile answers 422 FILTER_VALUE_UNRESOLVED with param linkedinUrl.

Response

Success

profiles
object[]
required
scrollToken
string | null
required

Send back as scrollToken for the next page; null when the provider returned no continuation.

total
integer | null
required

An estimate of the people matching the filters, not the page size, on the first page of a search on people filters only. Null on a search with employer filters (company size, revenue, industry, headquarters location or funding), which counts nothing with its rows, and on every page after the first: read it from the first page and carry it. A linkedinUrl lookup answers the rows found.

filters
object
required

The stored filters translated into the POST /prospects/search vocabulary — send these to reproduce the run there.

ignoredFilterKeys
string[]
required

Stored keys with no equivalent search field, dropped before running; the product's UI skips them too.

unappliedCompanyNames
object[]

Present only when the search left included company names out. The rest of each list was searched.