Skip to main content
GET
List contacts

Authorizations

session
string
cookie
required

A signed-in workspace session, sent as a browser cookie. Requests must include credentials, and act on the session's active workspace.

Query Parameters

q
string

Free-text search across the pool.

page
integer
default:1
Required range: x >= 1
pageSize
enum<integer>
default:25

Anything other than these values falls back to 25.

Available options:
10,
25,
50,
100
role
string[]

Repeatable.

company
string[]

Repeatable.

metro
string[]

Repeatable.

sector
string[]

Repeatable.

signal
string[]

Repeatable.

enriched
string[]

Repeatable. Filter by enrichment state.

contact
string[]

Repeatable. Filter by which contact details are present.

minScans
integer

Only people who appeared in at least this many searches.

Required range: x >= 0

Response

A page of contacts with facet counts.

The response is of type object.