POST/v1/people-search

People search

Search for people using filters Pagination billing: call the first page normally and save billing.requestId from the Orthogonal /v1/run response. For later page, offset, or cursor calls on the same logical search, pass parentRequestId with unchanged non-pagination parameters. Valid continuation calls still get their own request IDs and quoted price, but are charged 0. Changing filters starts a new billable request.

Fiber AI·Dynamic pricing

Dynamic pricing

body.pageSize ? body.pageSize * 0.02 : 0.50

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "fiber",
  path: "/v1/people-search"
});

console.log(output);

Body parameters

searchParams

object

Search parameters for people search.

pageSize

integer

The number of profiles to return, if you need to get more results, you can paginate.

cursor

string

A pagination cursor returned from a previous search response. Use this to fetch the next page of results. For later cursor pages of the same logical search, keep non-pagination parameters unchanged and pass top-level parentRequestId from the first Orthogonal /v1/run response.

currentCompanies

array

Filter people by the companies they are currently working for. If you want to search over many companies, we suggest using the Combined Search API, which is optimized for this use case.

prospectExclusionListIDs

array

Filter out people which belong to the given prospect exclusion lists

companyExclusionListIDs

array

Filter out people who work at companies which belong to the given company exclusion lists

Response

output.data.0.dob

null

output.data.0.url

string

output.data.0.name

string

output.data.0.tags

array

output.data.0.slugs.0

string

output.data.0.skills

null

output.data.0.courses

null

output.data.0.patents

null

output.data.0.premium

null

output.data.0.summary

null

output.data.0.tenures.0.titles.0

string

output.data.0.tenures.0.localities

array

output.data.0.tenures.0.company_name

string

output.data.0.tenures.0.range_length_days

null

output.data.0.tenures.0.linkedin_company_id

string

output.data.0.user_id

string

output.data.0.articles

null

output.data.0.headline

string

output.data.0.locality

string

output.data.0.projects

null

output.data.0.websites

null

output.data.0.education

null

output.data.0.interests

null

output.data.0.is_hiring

null

output.data.0.languages

array

output.data.0.last_name

string

output.data.0.entity_urn

null

output.data.0.first_name

string

output.data.0.influencer

null

output.data.0.current_job.title

string

output.data.0.current_job.summary

string

output.data.0.current_job.locality

null

output.data.0.current_job.start_date

string

output.data.0.current_job.company_name

string

output.data.0.current_job.linkedin_company_id

string

output.data.0.custom_data

null

output.data.0.entity_urns

null

output.data.0.experiences.0.title

string

output.data.0.experiences.0.summary

string

output.data.0.experiences.0.end_date

null

output.data.0.experiences.0.locality

null

output.data.0.experiences.0.seniority

string

output.data.0.experiences.0.is_current

boolean

output.data.0.experiences.0.start_date

string

output.data.0.experiences.0.company_name

string

output.data.0.experiences.0.job_function.0

string

output.data.0.experiences.0.employment_type.0

string

output.data.0.experiences.0.company_end_date

null

output.data.0.experiences.0.company_start_date

string

output.data.0.experiences.0.linkedin_company_id

string

output.data.0.experiences.0.academic_qualification

null

output.data.0.is_verified

null

output.data.0.profile_pic

string

output.data.0.open_to_work

null

output.data.0.primary_slug

string

output.data.0.publications

null

output.data.0.volunteering

null

output.data.0.industry_name

null

output.data.0.last_sort_key

string

output.data.0.organizations

null

priceCents

number

Actual Orthogonal credits charged for this /v1/run call. Accepted continuation pages are charged 0.

quotedPriceCents

number

Price this call would normally cost before continuation billing is applied.

billing.requestId

string

Unique Orthogonal request ID for this page or poll call. Save the first call requestId and pass it as parentRequestId on later pages.

billing.parentRequestId

string|null

Parent Orthogonal request ID when this call is a continuation of an earlier search.

billing.rootRequestId

string

Root Orthogonal request ID for the full logical search.

billing.continuation

boolean

True when this call was accepted as a continuation page or poll.

billing.billable

boolean

False for accepted continuation pages because they are not charged again.

billing.quotedPriceCents

number

Quoted price for this page or poll before continuation billing.

billing.chargedPriceCents

number

Actual credits charged for this page or poll. Accepted continuations return 0.

billing.aggregateChargedPriceCents

number

Total charged so far for the full logical search, including the first page and accepted continuations.