Skip to main content
POST
cURL
Returns the people at one company, narrowed by people filters. Records have the same shape as people search. Get companyId from company search. The body accepts the six people filters only. An unknown company id returns no records.

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.

companyId
string
required

Firmable company id, starting f, from company search. (example: f000000000101)

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 the six people filters only.

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

People at the company

records
object[]
total
integer

Total matching people

page
object