Skip to main content
POST
cURL
People search accepts every people and company filter. Company filters apply to the person’s employer. See Filters for the filters and the forms their codes take. Records carry contact availability flags only. Pass a record’s id to people enrichment for contact details.

Contact availability flags

Authorizations

Authorization
string
header
required

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

Path Parameters

partner
string
required

Your platform's identifier. Firmable gives it to you during onboarding.

Body

application/json
filters
object

An object of filter identifier to an array of 1 to 100 codes. Codes within one filter are combined with OR. Different filters are combined with AND. Get codes from GET /filter-options. Accepts every company and people filter.

country
enum<string>[]

The markets to search, as market codes. Every market when omitted.

Available options:
AU,
NZ,
SG,
MY,
ID,
PH,
TH,
VN,
HK,
JP,
KR,
US,
CA
page
object

Response

Matching people

records
object[]
total
integer

Total matching people

page
object