API access token

Workable

null if member has not provided a disqualification reason

The education id. If it is provided, the corresponding education entry will be updated. If not, a new entry will be created.

The experience id. If it is provided the corresponding experience entry will be updated. If not, a new entry will be created.

The date the candidate was moved to the hired stage

Recruiter keys can be retrieved from the jobs/:shortcode/recruiters endpoint.

the candidate’s resume encoded in base64

Last timestamp when candidate was updated

Candidates

Indicates whether the department has been archived or not.

The department identifier. Note that this id should be used when creating or updating an employee using the POST and PATCH endpoints respectively.

The department identifier of the parent department or null if it is a top level department.

Departments

Employees

A collection with the ancestor departments of the job department including that

Location of the job. When advertise elsewhere is used it contains the advertise location. When advertise elsewhere is not used, it contains the primary location of the job as defined in the job editor.

The country name as defined in job editor

The location string translated into the language of the job

Indicates if this is a remote/telecommute job

The workplace type. Possible values are on_site, hybrid, remote.

The job state. Possible values are draft, published, closed, archived.

Jobs

The member's HRIS role. Possible values are hris_admin and hris_employee

The member's role. Possible values are admin, simple and reviewer

Members

The state of the offer ('accepted', 'rejected', etc.)

Offers

Recruiters

The ID of the candidate. Only exists for filled and reserved requisitions.

The employment type. Can be one of Full-time, Part-time, Contract, Temporary, Other.

The string representation of the location

The plan date of the requisition in YYYY-MM-DD format

The reason for the requisition. Can be one of new_hire, replacement, backfill.

The 3-letter ISO code of the currency (ie EUR, USD).

The frequency of the salary. Can be one of hour, day, week, month, year.

The frequency of the salary range. Can be one of hour, day, week, month, year.

The start date of the requisition in YYYY-MM-DD format

The state of the requisition. Can be one of processing, draft, pending, approved, open, filled, rejected, cancelled, reserved, on_hold.

Requisitions

Shortcodes

The type of the stage. Possible values are sourced, applied, shortlisted, assessment, phone-screen, interview, offer & hired.

The position of the stage in the pipeline (zero based).

Stages

Accessible with all token types. Required scope: r_jobs.

Returns a collection of all the accounts you have access to.

Calling this endpoint will return the information about a specific account you have access to.

Returns the specified account

Accessible with account tokens and user tokens. Required scope: r_jobs.

Returns a collection of your account members

Returns a collection of your account external recruiters

Calling the /stages endpoint will return a collection of the recruitment pipeline stages as defined in recruiting preferences page.

Returns a collection of your recruitment pipeline stages.

Reject an offer

Returns a collection of the public jobs for an account

Returns a collection of the departments of the public jobs of the specified account

Returns a collection of the locations of the public jobs of the specified account

Retrieve a list of events for a specific employee

List all events

Get a specific event by ID

Use this endpoint for deleting subscriptions. It's recommended to delete obsolete subscriptions if you're a third party.

Unsubscribe from an event

Use this endpoint to list your subscriptions. Required scope: r_candidates or r_employees. Accessible with all token types.

List subscriptions

Subscribe to an event. Required scope: r_candidates or r_employees. Accessible with all token types. You can use this endpoint to register your service. The arguments object can be used to further filter which events you want to receive.

Subscribe to an event

This endpoint is used to upload documents for an employee. It requires the 'w_employees' scope which can be enabled through the integrations section found within the settings menu.

Uploads a list of documents for a specific employee.

Accessible with user level tokens and account level tokens that provide the member_id query param.

Returns a collection of the uploaded documents for a specific employee.

Updates an existing employee. Required scope: w_employees.

Updates an existing employee

Returns all relevant information for a specific employee. Required scope: r_employees. Accessible with user access tokens and with account level tokens that provide member_id query param.

Get specific employee information

This endpoint is used to create a new employee with various personal and professional details.

Creates an employee for your account.

Calling the /employees endpoint will return a collection of the available employees for the account. If you are using an account level token you will get only published employees with publicly available info. To get all types of employees there is a need to add member_id of an hr admin.

Returns a collection of your account employees

This endpoint returns a collection of the defined work schedules for the account. Required scope: r_account.

Returns a collection of your account work schedules

This endpoint returns a collection of the defined employee_fields for the account.

Returns a collection of your account employee_fields.

Returns a collection of the account's custom attributes.

Updates a custom attribute value for a candidate. Required scope: r_jobs. Accessible with all token types.

Updates a custom attribute value for a candidate.

Required scope: w_candidates. Accessible with all token types.

Creates a rating for a candidate

Calling the /candidates/:id/activities endpoint returns a JSON array of the candidate's activities.

Returns the activity stream of the given candidate

Moves the candidate to another stage. Required scope: w_candidates. Accessible with all token types. When an account has hiring plan enabled, in order to move a candidate to a stage of kind hired a requisition has to be filled.

Moves the candidate to another stage

Moves a candidate to another job. Required scope: w_candidates. Accessible with all token types. The only difference between the Copy and Relocate methods is that the Copy method preserves the source candidate while the Relocate method deletes it.

Moves a candidate to another job

Copies a candidate to another job. Required scope: w_candidates. Accessible with all token types.

Copies a candidate to another job

Reverts a candidate's disqualification. Required scope: `w_candidates`. Accessible with all token types.

Reverts a candidate's disqualification

Disqualifies a candidate. Required scope: `w_candidates`. Accessible with all token types.

Disqualifies a candidate

Updates candidate's tags. The tags list will be assigned to a candidate as is. If the array is empty, all tags of the candidate will be deleted.

Updates candidate's tags

Required scope: w_candidates or w_comments. Accessible with all token types.

Creates a comment on the candidate's timeline

Accessible with all token types. Required scope: r_candidates.

Returns the offer related data of the given candidate

This endpoint allows for partial updates to a candidate's information. It behaves like a PUT request for array keys (education_entries, experience_entries, social_profiles, tags), meaning the end result will match exactly the input provided. Any pre-existing entries not included in the request will be deleted.

Partially updates a candidate

Returns specified candidate

Creates a candidate at the specified job. Required scope: w_candidates. Accessible with all token types.

Creates a candidate at the specified job

This endpoint creates candidates in a specific job. It can be used for custom application forms, migration of existing candidates, or integration with other systems.

Accessible with all token types. By default results are limited to 50. The limit can be updated via the request parameter limit. The value specified cannot be more than 100 per page.

Returns a collection of the job's candidates

Calling the /jobs/{shortcode}/recruiters endpoint will return a collection of the external recruiters that are collaborators in the specified job.

Calling the /jobs/{shortcode}/members endpoint will return a collection of the defined members that are in the hiring team of the specified job. The role defined is on the account level.

Calling the endpoint will return a collection of the custom attributes that are applicable for the specified job.

Returns a collection of the custom attributes that are relevant to a specific job.

Calling the /stages endpoint will return a collection of the recruitment pipeline stages as defined in recruiting preferences page

Returns a collection of your recruitment pipeline stages

Returns the questions for the specified job

Required scope: r_jobs. Accessible with all token types.

Returns the details of the specified job

Calling the /jobs/{shortcode}/application_form endpoint returns a JSON object with two arrays, one with the application form fields and one array with the job's questions.

Returns the application form details for the specified job

Accessible with all token types. Requires scope `r_candidates`.

Returns the activity stream of the given job

Accessible with all token types. Results are sorted by the time inserted on system, in ascending order. By default, results are limited to 50 and can be updated via the `limit` request parameter up to a maximum of 100.

Returns a collection of your account jobs

Approves an offer (must be in a compatible state). Required scope: w_offers. Accessible only with user tokens.

Approves an offer

Accessible only with user tokens. Required scope: r_offers.

Returns an offer

Rejects a requisition (must be in a compatible state). Required scope: w_requisitions. Accessible with user tokens only.

Rejects a requisition

Approves a requisition (must be in a compatible state). Required scope: w_requisitions. Accessible with user tokens only.

Approves a requisition (must be in a compatible state).

Required scope: r_requisitions. Accessible with all token types.

Returns a requisition

By default results are limited to 50. The limit can be updated via the request parameter limit. The value specified cannot be more than 100.

Returns a collection of your account requisitions

Accessible with all token types. Required scope: r_account.

	List	Find by ID	Search	Match	Create	Update	Delete
Candidates	✅	✅	➖	✅	✅	✅	➖
Employees	✅	✅	✅	➖	✅	✅	➖
Requisitions	✅	✅	➖	➖	➖	✅	➖
Jobs	✅	➖	➖	✅	➖	➖	➖
Offers	➖	✅	➖	➖	➖	✅	➖
Departments	✅	➖	➖	➖	➖	➖	➖

	Jobs automatically maps to	Job Candidates automatically maps to	Employees automatically maps to
Lever	Postings	Opportunities	—
Greenhouse Harvest	Jobs	Candidates	—
Breezy HR	Positions	Candidates	—
Recruitee	Offers	Candidates	—
Ashby	Jobs	Candidates	—
BambooHR	Jobs	—	Employees
Workday	—	—	—
Rippling HR	—	—	Employees
Gusto	—	—	Employees
Personio	—	—	Employees

Workable integration connector

Managed authentication

Execute Workable operations on behalf of your customers

Returns a collection of all the accounts you have access to.

Returns the specified account

Returns a collection of your account members

Returns a collection of your account external recruiters

Returns a collection of your recruitment pipeline stages.

Reject an offer

Work with Workable data collections

Trigger integrations on Workable events

Data Record Created

Data Record Updated

Data Record Deleted

Use the same code to integrate with Workable and 100+ other applications

Jobs

Job Candidates

Employees

Try our AI-powered integration development environment for free

Workable integration connector

Managed authentication

Execute Workable operations on behalf of your customersself.__wrap_n!=1&&self.__wrap_b(":Rat56:",1)

Returns a collection of all the accounts you have access to.

Returns the specified account

Returns a collection of your account members

Returns a collection of your account external recruiters

Returns a collection of your recruitment pipeline stages.

Reject an offer

Work with Workable data collectionsself.__wrap_n!=1&&self.__wrap_b(":Rb556:",1)

Trigger integrations on Workable eventsself.__wrap_n!=1&&self.__wrap_b(":Rbd56:",1)

Data Record Created

Data Record Updated

Data Record Deleted

Use the same code to integrate with Workable and 100+ other applicationsself.__wrap_n!=1&&self.__wrap_b(":Rbl56:",1)

Jobs

Job Candidates

Employees

Try our AI-powered integration development environment for free

Execute Workable operations on behalf of your customers

Work with Workable data collections

Trigger integrations on Workable events

Use the same code to integrate with Workable and 100+ other applications