GET/company/employees/

Employee Listing

List a company's employees. Charged up front for page_size (default 10; max 10 with enrich or if-recent) at $0.0708 per employee. Per employee: country +$0.0708, enrich_profiles=enrich +$0.0236, use_cache=if-recent +$0.0472. Role search: +$0.236 per call and +$0.0708 per employee. sort_by: +$1.18 per call and +$0.236 per employee ($4.25 at page_size 10). Call Employee Count first so you don't pay for more employees than exist.

Enrich Layer·Dynamic pricing

Dynamic pricing

0.0236 * ((query.boolean_role_search ? 1 : (query.role_search ? 1 : 0)) * 10 + (query.sort_by ? (query.sort_by != "none" ? 50 : 0) : 0) + (query.resolve_numeric_id ? (query.resolve_numeric_id != "false" ? 2 : 0) : 0) + ((query.enrich_profiles=="enrich" ? 1 : (query.use_cache=="if-recent" ? 1 : 0)) ? min((query.page_size > 0 ? min(query.page_size, 9999) : 10), 10) : (query.page_size > 0 ? min(query.page_size, 9999) : 10)) * (3 + (query.boolean_role_search ? 1 : (query.role_search ? 1 : 0)) * 3 + (query.country ? 3 : 0) + (query.enrich_profiles=="enrich" ? 1 : 0) + (query.use_cache=="if-recent" ? 2 : 0) + (query.sort_by ? (query.sort_by != "none" ? 10 : 0) : 0)))

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: "enrich-layer",
  path: "/company/employees/",
  query: {
    "url": "example"
  }
});

console.log(output);

Query parameters

urlrequired

string

URL of the Company Profile to target.

coy_name_match

string

include (default): also list profiles whose work experience exactly matches the company name, not just the company URL. exclude: match by company URL only.

use_cache

string

if-present (default): no freshness guarantee. if-recent: best effort profiles no older than 29 days, +$0.0472 per employee; limits page_size to 10.

country

string

Comma-separated ISO 3166-1 alpha-2 country codes, case-insensitive (e.g. us or us,sg). +$0.0708 per employee.

enrich_profiles

string

skip (default): profile URLs only. enrich: full employee profiles, +$0.0236 per employee; limits page_size to 10.

boolean_role_search

string

Filter by job title with a boolean search expression (max 255 chars, case-insensitive). Takes precedence over role_search. +$0.236 per call and +$0.0708 per employee.

role_search

string

Deprecated; use boolean_role_search. Case-insensitive Lucene regular expression matched against the title, anchored at both ends (wrap in .* for partial matches). +$0.236 per call and +$0.0708 per employee.

page_size

string

Max employees returned, 1 to 9999 (default 10). Max 10 with enrich_profiles=enrich or use_cache=if-recent. You are charged up front for this many employees, so set it to what you need (check Employee Count first).

employment_status

string

Parameter to tell the API to return past or current employees. Valid values are `current`, `past`, and `all`: * `current` (default) : lists current employees * `past` : lists past employees * `all` : lists current & past employees

sort_by

string

recently-joined, recently-left, oldest, or none (default). Any value other than none adds $1.18 per call and $0.236 per employee ($4.25 total at page_size 10). Use only when order matters.

resolve_numeric_id

string

true: support company URLs with numeric IDs, +$0.0472 per call. false (default).

after

string

The cursor for fetching the next page of results. Take the value of the `after` query parameter from the `next_page` URL of the previous response.