Firmable: People Search

Search for people by id, company id, position, seniority, and department.

Tool ID: firmable_people_search

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'firmable_people_search',
  {
    "companyId": "company_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute firmable_people_search --input '{
  "companyId": "company_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": [
    {
      "person_id": "person_123",
      "position": "example",
      "company_name": "Example Corp"
    }
  ]
}

Use deepline describe firmable_people_search --json for the latest machine-readable contract.

Input reference

Search for people by id, company id, position, seniority, and department

Name	Type	Required	Default	Details
`payload.selectedCountry`	`"AU" \| "NZ" \| "SG" \| "MY" \| "ID" \| "PH" \| "HK" \| "JP" \| "VN" \| "KR" \| "TH" \| "US" \| "CA"`	No	—	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) Allowed: `AU`, `NZ`, `SG`, `MY`, `ID`, `PH`, `HK`, `JP`, `VN`, `KR`, `TH`, `US`, `CA`.
`payload.companyId`	`string`	Yes	—	The unique identifier for a company in the Firmable system. (example: f000000117274)
`payload.position`	`string`	No	—	The position of the person. (example: Software Engineer)
`payload.seniority`	`string`	No	—	The seniority of the person. (example: Senior)
`payload.department`	`string`	No	—	The department of the person. (example: Engineering)
`payload.from`	`string`	No	—	The offset to start the search from. (example: 0)
`payload.size`	`string`	No	—	The size of the search results. (example: 10)

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`array \| object`	Yes	—	Firmable people search results or the observed zero-match response.
`result.data.success`	`boolean`	Yes	—	—
`result.data.totalPeople`	`integer`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: per_result (per result).
Estimated Deepline credits: 3.57 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation