New to Corsair? See API access, authentication, and error handling.
Accounts
get
accounts.get
Get account metadata by subdomain
Risk: read
Output
list
accounts.list
List all Workable accounts accessible to the authenticated token
Risk: read
accounts full type
accounts full type
Candidates
list
candidates.list
List candidates across all jobs
Risk: read
Output
candidates full type
candidates full type
paging full type
paging full type
Custom Attributes
list
customAttributes.list
List custom attributes configured on the account
Risk: read
Departments
create
departments.create
Create a department
Risk: write
Output
delete
departments.delete
Delete a department
Risk: destructive
Output
list
departments.list
List all departments
Risk: read
object[]
Output full type
Output full type
merge
departments.merge
Merge a department into another department
Risk: destructive · Irreversible
Output
update
departments.update
Update a department’s name or parent
Risk: write
Output
Disqualification Reasons
list
disqualificationReasons.list
List disqualification reasons
Risk: read
Record<string, any>[]
Employee Fields
list
employeeFields.list
List employee field definitions
Risk: read
Record<string, any>[]
Employees
create
employees.create
Create an employee in draft or published state
Risk: write
Output
get
employees.get
Get a specific employee by ID
Risk: read
Output
list
employees.list
List/search employees
Risk: read
Output
employees full type
employees full type
update
employees.update
Update an employee’s details
Risk: write
Output
uploadDocuments
employees.uploadDocuments
Upload documents for an employee
Risk: write
documents full type
documents full type
Events
list
events.list
List scheduled events
Risk: read
Output
Jobs
list
jobs.list
List jobs
Risk: read
Output
jobs full type
jobs full type
paging full type
paging full type
Legal Entities
list
legalEntities.list
List account legal entities
Risk: read
Record<string, any>[]
Members
enable
members.enable
Reactivate a deactivated member
Risk: write
Output
invite
members.invite
Invite a new member by email
Risk: write
Output
list
members.list
List account members
Risk: read
Output
members full type
members full type
update
members.update
Update a member’s roles or collaboration rules
Risk: write
Output
Permission Sets
list
permissionSets.list
List permission sets
Risk: read
Record<string, any>[]
Public Jobs
list
publicJobs.list
List an account’s public job postings (no authentication required)
Risk: read
Output
Public Locations
list
publicLocations.list
List the locations of an account’s public jobs with per-country counts (no authentication required)
Risk: read
Output:
object[]
Output full type
Output full type
Recruiters
list
recruiters.list
List external recruiters
Risk: read
Output
Requisitions
list
requisitions.list
List requisitions
Risk: read
Output
paging full type
paging full type
Stages
list
stages.list
List recruitment pipeline stages
Risk: read
Subscriptions
create
subscriptions.create
Subscribe to a candidate or employee webhook event
Risk: write
args full type
args full type
delete
subscriptions.delete
Delete a webhook subscription
Risk: destructive
Output
list
subscriptions.list
List webhook subscriptions
Risk: read
Timeoff Balances
list
timeoffBalances.list
List employee time-off balances
Risk: read
Output
Timeoff Categories
list
timeoffCategories.list
List time-off categories
Risk: read
Work Schedules
list
workSchedules.list
List work schedules
Risk: read
Record<string, any>[]