API - Corsair

Every workable.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Accounts

get

accounts.get Get account metadata by subdomain Risk: read

await corsair.workable.api.accounts.get({ subdomain: 'acme' });

Input

Name	Type	Required	Description
`subdomain`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`subdomain`	`string`	No	—
`description`	`string`	No	—
`summary`	`string`	No	—
`website_url`	`string`	No	—

list

accounts.list List all Workable accounts accessible to the authenticated token Risk: read

await corsair.workable.api.accounts.list({});

Input: empty object Output

Name	Type	Required	Description
`accounts`	`object[]`	Yes	—

accounts full type

{
  id?: string,
  name?: string | null,
  subdomain?: string | null,
  description?: string | null,
  summary?: string | null,
  website_url?: string | null
}[]

Candidates

list

candidates.list List candidates across all jobs Risk: read

await corsair.workable.api.candidates.list({ shortcode: 'GROOV003', stage: 'interview', limit: 50 });

Input

Name	Type	Required	Description
`email`	`string`	No	—
`shortcode`	`string`	No	—
`stage`	`string`	No	—
`limit`	`number`	No	—
`since_id`	`string`	No	—
`max_id`	`string`	No	—
`created_after`	`string`	No	—
`updated_after`	`string`	No	—

Output

Name	Type	Required	Description
`candidates`	`object[]`	Yes	—
`paging`	`object`	No	—

candidates full type

{
  id?: string,
  name?: string | null,
  firstname?: string | null,
  lastname?: string | null,
  email?: string | null,
  job?: {
    shortcode?: string | null,
    title?: string | null
  } | null,
  stage?: string | null,
  disqualified?: boolean | null,
  created_at?: Date | null,
  updated_at?: Date | null
}[]

paging full type

{
  next?: string
}

Custom Attributes

list

customAttributes.list List custom attributes configured on the account Risk: read

await corsair.workable.api.customAttributes.list({});

Input: empty object Output

Name	Type	Required	Description
`custom_attributes`	`object[]`	Yes	—

custom_attributes full type

{
}[]

Departments

create

departments.create Create a department Risk: write

await corsair.workable.api.departments.create({ name: 'Engineering', parent_id: '3ff4d64b' });

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`parent_id`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`parent_id`	`string`	No	—

delete

departments.delete Delete a department Risk: destructive

await corsair.workable.api.departments.delete({ id: '3ff4d641', force: true });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`force`	`boolean`	No	—

Output

Name	Type	Required	Description
`message`	`string`	No	—
`success`	`boolean`	No	—

list

departments.list List all departments Risk: read

await corsair.workable.api.departments.list({});

Input: empty object Output: object[]

Output full type

{
  id?: string,
  name?: string | null,
  parent_id?: string | null
}[]

merge

departments.merge Merge a department into another department Risk: write

await corsair.workable.api.departments.merge({ id: '3ff4d641', target_department_id: '3ff4d64b', force: true });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`target_department_id`	`string`	Yes	—
`force`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`parent_id`	`string`	No	—

update

departments.update Update a department’s name or parent Risk: write

await corsair.workable.api.departments.update({ id: '3ff4d641', name: 'Platform Engineering', parent_id: null });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`parent_id`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`parent_id`	`string`	No	—

Disqualification Reasons

list

disqualificationReasons.list List disqualification reasons Risk: read

await corsair.workable.api.disqualificationReasons.list({});

Input: empty object Output: object[]

Output full type

{
}[]

Employee Fields

list

employeeFields.list List employee field definitions Risk: read

await corsair.workable.api.employeeFields.list({});

Input: empty object Output: object[]

Output full type

{
}[]

Employees

create

employees.create Create an employee in draft or published state Risk: write

await corsair.workable.api.employees.create({ state: 'draft', employee: { firstname: 'Jordan', lastname: 'Lee', work_email: 'jordan@acme.com', start_date: '2026-12-01T00:00:00.000Z' } });

Input

Name	Type	Required	Description
`state`	`draft \| published`	Yes	—
`member_id`	`string`	No	—
`employee`	`object`	Yes	—

employee full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	No	—
`firstname`	`string`	No	—
`lastname`	`string`	No	—
`email`	`string`	No	—
`state`	`draft \| published \| string`	No	—
`job_title`	`string`	No	—
`department_id`	`string`	No	—
`manager_id`	`string`	No	—

get

employees.get Get a specific employee by ID Risk: read

await corsair.workable.api.employees.get({ id: '375b' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`member_id`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`firstname`	`string`	No	—
`lastname`	`string`	No	—
`email`	`string`	No	—
`state`	`draft \| published \| string`	No	—
`job_title`	`string`	No	—
`department_id`	`string`	No	—
`manager_id`	`string`	No	—

list

employees.list List/search employees Risk: read

await corsair.workable.api.employees.list({ query: 'doe', limit: 50, offset: 0 });

Input

Name	Type	Required	Description
`limit`	`10 \| 20 \| 50 \| 100`	No	—
`offset`	`number`	No	—
`query`	`string`	No	—
`order_by`	`string`	No	—
`member_id`	`string`	No	—

Output

Name	Type	Required	Description
`employees`	`object[]`	Yes	—
`total_count`	`number`	No	—
`totalCount`	`number`	No	—

employees full type

{
  id?: string,
  firstname?: string | null,
  lastname?: string | null,
  email?: string | null,
  state?: draft | published | string | null,
  job_title?: string | null,
  department_id?: string | null,
  manager_id?: string | null
}[]

update

employees.update Update an employee’s details Risk: write

await corsair.workable.api.employees.update({ id: '375b', employee: { job_title: 'Account Manager' } });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`member_id`	`string`	No	—
`employee`	`object`	Yes	—

employee full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	No	—
`firstname`	`string`	No	—
`lastname`	`string`	No	—
`email`	`string`	No	—
`state`	`draft \| published \| string`	No	—
`job_title`	`string`	No	—
`department_id`	`string`	No	—
`manager_id`	`string`	No	—

uploadDocuments

employees.uploadDocuments Upload documents for an employee Risk: write

await corsair.workable.api.employees.uploadDocuments({ id: '375b', documents: [{ url: 'https://files.acme.com/signed/offer.pdf', name: 'Offer letter' }] });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`member_id`	`string`	No	—
`documents`	`object[]`	Yes	—

documents full type

{
  url: string,
  name: string
}[]

Output

Name	Type	Required	Description
`message`	`string`	No	—
`success`	`boolean`	No	—

Events

list

events.list List scheduled events Risk: read

await corsair.workable.api.events.list({ type: 'interview', start_date: '2026-11-01', limit: 50 });

Input

Name	Type	Required	Description
`type`	`call \| interview \| meeting`	No	—
`limit`	`number`	No	—
`start_date`	`string`	No	—
`end_date`	`string`	No	—
`candidate_id`	`string`	No	—
`shortcode`	`string`	No	—
`member_id`	`string`	No	—
`context`	`user \| team \| all`	No	—
`include_cancelled`	`boolean`	No	—
`since_id`	`string`	No	—
`max_id`	`string`	No	—

Output

Name	Type	Required	Description
`events`	`object[]`	Yes	—

events full type

{
}[]

Jobs

list

jobs.list List jobs Risk: read

await corsair.workable.api.jobs.list({ state: 'published', limit: 50 });

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`state`	`draft \| published \| archived \| closed`	No	—
`created_after`	`string`	No	—
`updated_after`	`string`	No	—
`since_id`	`string`	No	—
`max_id`	`string`	No	—
`include_fields`	`string`	No	—

Output

Name	Type	Required	Description
`jobs`	`object[]`	Yes	—
`paging`	`object`	No	—

jobs full type

{
  id?: string,
  title?: string | null,
  shortcode?: string | null,
  state?: draft | published | closed | archived | string | null,
  department?: string | null,
  url?: string | null,
  created_at?: Date | null,
  updated_at?: Date | null
}[]

paging full type

{
  next?: string
}

Legal Entities

list

legalEntities.list List account legal entities Risk: read

await corsair.workable.api.legalEntities.list({});

Input: empty object Output: object[]

Output full type

{
}[]

Members

enable

members.enable Reactivate a deactivated member Risk: write

await corsair.workable.api.members.enable({ id: '3dae63e5' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`message`	`string`	No	—
`success`	`boolean`	No	—

invite

members.invite Invite a new member by email Risk: write

await corsair.workable.api.members.invite({ email: 'jordan@acme.com', roles: ['ats.simple'] });

Input

Name	Type	Required	Description
`email`	`string`	Yes	—
`roles`	`ats.admin \| ats.simple \| ats.reviewer \| hris.admin \| hris.employee \| hris.limited \| workable.superadmin[]`	Yes	—
`member_id`	`string`	No	—
`collaboration_rules`	`object[]`	No	—

collaboration_rules full type

{
}[]

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`headline`	`string`	No	—
`email`	`string`	No	—
`roles`	`string[]`	No	—
`active`	`boolean`	No	—
`collaboration_rules`	`any[]`	No	—

list

members.list List account members Risk: read

await corsair.workable.api.members.list({ status: 'active', limit: 50 });

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`since_id`	`string`	No	—
`max_id`	`string`	No	—
`role`	`string`	No	—
`shortcode`	`string`	No	—
`email`	`string`	No	—
`name`	`string`	No	—
`status`	`active \| inactive \| all`	No	—

Output

Name	Type	Required	Description
`members`	`object[]`	Yes	—

members full type

{
  id?: string,
  name?: string | null,
  headline?: string | null,
  email?: string | null,
  roles?: string[] | null,
  active?: boolean | null,
  collaboration_rules?: any[]
}[]

update

members.update Update a member’s roles or collaboration rules Risk: write

await corsair.workable.api.members.update({ id: '3dae63e5', roles: ['ats.admin'] });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`roles`	`ats.admin \| ats.simple \| ats.reviewer \| hris.admin \| hris.employee \| hris.limited \| workable.superadmin[]`	Yes	—
`collaboration_rules`	`object[]`	No	—

collaboration_rules full type

{
}[]

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`headline`	`string`	No	—
`email`	`string`	No	—
`roles`	`string[]`	No	—
`active`	`boolean`	No	—
`collaboration_rules`	`any[]`	No	—

Permission Sets

list

permissionSets.list List permission sets Risk: read

await corsair.workable.api.permissionSets.list({});

Input: empty object Output: object[]

Output full type

{
}[]

Public Jobs

list

publicJobs.list List an account’s public job postings (no authentication required) Risk: read

await corsair.workable.api.publicJobs.list({ subdomain: 'acme', details: true });

Input

Name	Type	Required	Description
`subdomain`	`string`	No	—
`details`	`boolean`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`description`	`string`	No	—
`jobs`	`object[]`	No	—

jobs full type

{
}[]

Public Locations

list

publicLocations.list List the locations of an account’s public jobs with per-country counts (no authentication required) Risk: read

await corsair.workable.api.publicLocations.list({ subdomain: 'acme' });

Input

Name	Type	Required	Description
`subdomain`	`string`	No	—

Output: object[]

Output full type

{
  code?: string | null,
  name?: string | null,
  count?: number | null,
  url?: string | null
}[]

Recruiters

list

recruiters.list List external recruiters Risk: read

await corsair.workable.api.recruiters.list({});

Input

Name	Type	Required	Description
`shortcode`	`string`	No	—

Output

Name	Type	Required	Description
`recruiters`	`object[]`	Yes	—

recruiters full type

{
}[]

Requisitions

list

requisitions.list List requisitions Risk: read

await corsair.workable.api.requisitions.list({ limit: 50 });

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`since_id`	`string`	No	—
`max_id`	`string`	No	—

Output

Name	Type	Required	Description
`requisitions`	`object[]`	Yes	—
`paging`	`object`	No	—

requisitions full type

{
}[]

paging full type

{
  next?: string
}

Stages

list

stages.list List recruitment pipeline stages Risk: read

await corsair.workable.api.stages.list({});

Input: empty object Output

Name	Type	Required	Description
`stages`	`object[]`	Yes	—

stages full type

{
}[]

Subscriptions

create

subscriptions.create Subscribe to a candidate or employee webhook event Risk: write

await corsair.workable.api.subscriptions.create({ target: 'https://example.com/workable/webhooks', event: 'candidate_created' });

Input

Name	Type	Required	Description
`target`	`string`	Yes	—
`event`	`candidate_created \| candidate_moved \| employee_created \| employee_updated \| employee_published \| onboarding_completed \| timeoff_updated`	Yes	—
`args`	`object`	No	—

args full type

{
  account_id?: string,
  job_shortcode?: string,
  stage_slug?: string
}

Output

Name	Type	Required	Description
`id`	`number \| string`	No	—

delete

subscriptions.delete Delete a webhook subscription Risk: destructive

await corsair.workable.api.subscriptions.delete({ id: '42' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`message`	`string`	No	—
`success`	`boolean`	No	—

list

subscriptions.list List webhook subscriptions Risk: read

await corsair.workable.api.subscriptions.list({});

Input: empty object Output

Name	Type	Required	Description
`subscriptions`	`object[]`	Yes	—

subscriptions full type

{
}[]

Timeoff Balances

list

timeoffBalances.list List employee time-off balances Risk: read

await corsair.workable.api.timeoffBalances.list({ employee_id: '375b' });

Input

Name	Type	Required	Description
`employee_id`	`string`	No	The employee whose balances to read. Required with an account token; a user token defaults to its own employee.

Output

Name	Type	Required	Description
`balances`	`object[]`	Yes	—

balances full type

{
}[]

Timeoff Categories

list

timeoffCategories.list List time-off categories Risk: read

await corsair.workable.api.timeoffCategories.list({});

Input: empty object Output

Name	Type	Required	Description
`categories`	`object[]`	Yes	—

categories full type

{
}[]

Work Schedules

list

workSchedules.list List work schedules Risk: read

await corsair.workable.api.workSchedules.list({});

Input: empty object Output: object[]

Output full type

{
}[]

​Accounts

​get

​list

​Candidates

​list

​Custom Attributes

​list

​Departments

​create

​delete

​list

​merge

​update

​Disqualification Reasons

​list

​Employee Fields

​list

​Employees

​create

​get

​list

​update

​uploadDocuments

​Events

​list

​Jobs

​list

​Legal Entities

​list

​Members

​enable

​invite

​list

​update

​Permission Sets

​list

​Public Jobs

​list

​Public Locations

​list

​Recruiters

​list

​Requisitions

​list

​Stages

​list

​Subscriptions

​create

​delete

​list

​Timeoff Balances

​list

​Timeoff Categories

​list

​Work Schedules

​list

Accounts

get

list

Candidates

list

Custom Attributes

list

Departments

create

delete

list

merge

update

Disqualification Reasons

list

Employee Fields

list

Employees

create

get

list

update

uploadDocuments

Events

list

Jobs

list

Legal Entities

list

Members

enable

invite

list

update

Permission Sets

list

Public Jobs

list

Public Locations

list

Recruiters

list

Requisitions

list

Stages

list

Subscriptions

create

delete

list

Timeoff Balances

list

Timeoff Categories

list

Work Schedules

list