Skip to main content
POST
cURL

Description

Search for people by company id, position, seniority, and department. Use the selectedCountry field to scope results to a specific region. Supported country codes: AU, NZ, SG, MY, ID, PH, HK, JP, VN, KR, TH, US, CA. Defaults to AU when not provided. Please pass ids for seniority and department as listed below.

Acceptable seniority and department ids

Seniority:

  • 1: Board Member / Company Director
  • 2: Owner / Founder
  • 3: C-Suite / Partner
  • 4: VP/Director / Head of
  • 5: Manager
  • 6: Other
  • 7: No Data Available

Department:

  • 1: General Management
  • 2: Sales
  • 3: Trades
  • 4: Operations
  • 5: Engineering & Technical
  • 6: Human Resources
  • 7: Customer Service
  • 8: Medicine & Healthcare
  • 9: Research & Analysis
  • 10: Legal
  • 11: Marketing
  • 12: Education & Training
  • 13: Consulting
  • 14: Finance
  • 15: Product
  • 16: Other
  • 17: No Data Available

Authorizations

Authorization
string
header
required

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

Body

application/json
companyId
string
required

The unique identifier for a company in the Firmable system. (example: f000000117274)

selectedCountry
enum<string>

The country to search against. Supported values: AU, NZ, SG, MY, ID, PH, HK, JP, VN, KR, TH, US, CA. Defaults to AU when not provided. (example: AU)

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

The position of the person. (example: Software Engineer)

seniority
string

The seniority of the person. (example: Senior)

department
string

The department of the person. (example: Engineering)

from
string

The offset to start the search from. (example: 0)

size
string

The size of the search results. (example: 10)

Response

People search response

success
boolean

Whether any people matched the search. When false, records and total are not returned and totalPeople is 0.

Example:

true

total
integer

The total number of people that match the search.

Example:

123

totalPeople
integer

Only returned when no people match the search. Always 0.

Example:

0

records
object[]

The people on this page of results.