# Workable Documentation

> The Workable API provides full control over your recruiting data. Integrate the data from Workable's ATS into your company's internal systems.

## API Reference
- [Getting started](https://workable.readme.io/reference/generate-an-access-token.md): API access to your recruiting data
- [Workable MCP Server](https://workable.readme.io/reference/workable-mcp-server.md): Bridges AI assistants directly with the Workable platform
- [/accounts](https://workable.readme.io/reference/accounts.md): Returns a collection of all the accounts you have access to. Required scope: `r_jobs`. Accessible with all token types.
- [/accounts/:subdomain](https://workable.readme.io/reference/accountssubdomain.md): Returns the specified account. Required scope: `r_jobs`. Accessible with all token types.
- [/permission_sets](https://workable.readme.io/reference/permission-sets.md): Returns a collection of your account permission sets. Required scope: `r_account`. Accessible with all token types.
- [/members](https://workable.readme.io/reference/members.md): Returns a collection of your account members. Required scope: `r_jobs`. Accessible with account tokens and user tokens.
- [/members](https://workable.readme.io/reference/members-put.md): Updates a member. Required scope: `w_members`. Accessible with all token types.
- [/members/invite](https://workable.readme.io/reference/members-invite.md): Invites a member. Required scope: `w_members`. Accessible with all token types.
- [/members/:id](https://workable.readme.io/reference/members-delete.md): Deactivates a member. Required scope: `w_members`. Accessible with all token types.
- [/members/:id/enable](https://workable.readme.io/reference/members-enable.md): Restores a deactivated member. Required scope: `w_members`. Accessible with all token types.
- [/recruiters](https://workable.readme.io/reference/recruiters.md): Returns a collection of your account external recruiters. Required scope: `r_jobs`. Accessible with account tokens and user tokens.
- [/stages](https://workable.readme.io/reference/stages.md): Returns a collection of your recruitment pipeline stages. Required scope: r_jobs. Accessible with all token types.
- [/collaboration_permissions](https://workable.readme.io/reference/collaboration_permissions.md): Returns the effective collaboration permissions configuration. Required scope: `r_jobs`. Accessible with all token types.
- [/departments](https://workable.readme.io/reference/departments.md): Returns a collection of your account departments. Required scope: `r_account`. Accessible with all token types.
- [/departments](https://workable.readme.io/reference/departments-post.md): Creates a department in your account. Required scope: `w_departments`. Accessible with all token types.
- [/departments](https://workable.readme.io/reference/departments-put.md): Updates an existing department in your account. Required scope: `w_departments`. Accessible with all token types.
- [/departments/:id/merge](https://workable.readme.io/reference/departments-merge.md): Merges an existing department with a target one in your account. Required scope: `w_departments`. Accessible with all token types.
- [/departments/:id](https://workable.readme.io/reference/departments-delete.md): Deletes a department. Required scope: `w_departments`. Accessible with all token types.
- [/legal_entities](https://workable.readme.io/reference/legal_entities.md): Returns a collection of your account legal entities. Required scope: `r_account`. Accessible with all token types.
- [/disqualification_reasons](https://workable.readme.io/reference/disqualification_reasons.md): Returns a collection of account’s disqualification reasons. Required scope: `r_jobs`. Accessible with all token types.
- [/requisitions](https://workable.readme.io/reference/requisitions.md): Returns a collection of your account requisitions. Required scope: `r_requisitions`. Accessible with all token types for accounts with Hiring Plan.
- [/requisitions/:code](https://workable.readme.io/reference/requisitionscode.md): Returns a requisition. Required scope: `r_requisitions`. Accessible with all token types for accounts with Hiring Plan.
- [/requisitions](https://workable.readme.io/reference/requisitions-post.md): Creates a requisition. Required scope: `w_requisitions`. For accounts with Hiring Plan.
- [/requisitions](https://workable.readme.io/reference/requisitions-patch.md): Updates a requisition. Required scope: `w_requisitions`. For accounts with Hiring Plan.
- [/requisitions/:code/approve](https://workable.readme.io/reference/requisitions-approve.md): Approves a requisition (must be in a compatible state). Required scope: `w_requisitions`. For accounts with Hiring Plan.
- [/requisitions/:code/reject](https://workable.readme.io/reference/requisitions-reject.md): Rejects a requisition (must be in a compatible state). Required scope: `w_requisitions`. For accounts with Hiring Plan.
- [/offers/:id](https://workable.readme.io/reference/requisitionscode-copy-1.md): Returns an offer. Required scope: `r_offers`. Accessible only with user tokens.
- [/offers/:id/approve](https://workable.readme.io/reference/offersidapprove-copy.md): Approves an offer (must be in a compatible state). Required scope: `w_offers`. Accessible only with user tokens.
- [/offers/:id/reject](https://workable.readme.io/reference/offersidapprove-copy-1.md): Rejects an offer (must be in a compatible state). Required scope: `w_offers`. Accessible only with user tokens.
- [/jobs](https://workable.readme.io/reference/jobs.md): Returns a collection of your account jobs. Required scope: `r_jobs`. Accessible with all token types.
- [/jobs/:shortcode](https://workable.readme.io/reference/jobsshortcode.md): Returns the details of the specified job. Required scope: `r_jobs`. Accessible with all token types.
- [/jobs/:shortcode/activities](https://workable.readme.io/reference/job-activities.md): Returns the activity stream of the given job. Requires scope `r_candidates`. Accessible with all token types.
- [/jobs/:shortcode/application_form](https://workable.readme.io/reference/jobsshortcodeapplication_form.md): Returns the application form details for the specified job. Required scope: `r_jobs`. Accessible with all token types.
- [/jobs/:shortcode/questions](https://workable.readme.io/reference/job-questions.md): Returns the questions for the specified job. Required scope: `r_jobs`. Accessible with all token types.
- [/jobs/:shortcode/stages](https://workable.readme.io/reference/job-stages.md): Returns a collection of your recruitment pipeline stages. Required scope: `r_jobs`. Accessible with all token types.
- [/jobs/:shortcode/custom_attributes](https://workable.readme.io/reference/job-custom-attributes.md): Returns a collection of the custom attributes that are relevant to a specific job. Required scope: `r_jobs`. Accessible with all token types.
- [/jobs/:shortcode/members](https://workable.readme.io/reference/job-members.md): Returns a collection of your account members. Required scope: `r_jobs`. Accessible with account tokens and user tokens.
- [/jobs/:shortcode/recruiters](https://workable.readme.io/reference/new-jobsshortcoderecruiters.md): Returns a collection of your account external recruiters. Required scope: `r_jobs`. Accessible with account tokens and user tokens.
- [/candidates](https://workable.readme.io/reference/job-candidates-index.md): Returns a collection of the job's candidates. Required scope: `r_candidates`. Accessible with all token types.
- [/jobs/:shortcode/candidates](https://workable.readme.io/reference/job-candidates-create.md): Creates a candidate at the specified job. Required scope: `w_candidates`. Accessible with all token types.
- [/talent_pool/candidates](https://workable.readme.io/reference/talent-pool-candidates-create.md): Creates a candidate in the talent pool. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id](https://workable.readme.io/reference/job-candidates-show.md): Returns specified candidate. Required scope: `r_candidates`. Accessible with all token types.
- [/candidates/:id](https://workable.readme.io/reference/update-candidate.md): Partially updates a candidate. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/activities](https://workable.readme.io/reference/candidate-activities.md): Returns the activity stream of the given candidate. Required scope: `r_candidates`. Accessible with all token types.
- [/candidates/:id/files](https://workable.readme.io/reference/candidate-files.md): Returns the files associated with the given candidate. Accessible with all token types.
- [/candidates/:id/offer](https://workable.readme.io/reference/candidatesidoffer.md): Returns the offer related data of the given candidate. Required scope: `r_candidates`. Accessible with all token types.
- [/candidates/:id/comments](https://workable.readme.io/reference/comment-on-candidate.md): Creates a comment on the candidate's timeline. Required scope: `w_candidates` or `w_comments`. Accessible with all token types.
- [/candidates/:id/tags](https://workable.readme.io/reference/tag-candidate.md): Updates candidate's tags. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/disqualify](https://workable.readme.io/reference/disqualify-candidate.md): Disqualifies a candidate. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/revert](https://workable.readme.io/reference/revert-disqualification-candidate.md): Reverts a candidate's disqualification. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/copy](https://workable.readme.io/reference/copy-candidate.md): Copies a candidate to another job. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/relocate](https://workable.readme.io/reference/relocate-candidates.md): Moves a candidate to another job. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/move](https://workable.readme.io/reference/move-candidate.md): Moves the candidate to another stage. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/ratings](https://workable.readme.io/reference/rate-candidate.md): Creates a rating for a candidate. Required scope: `w_candidates`. Accessible with all token types.
- [/candidates/:id/ratings](https://workable.readme.io/reference/update-candidate-rating.md): Updates or creates  an evaluation  for a candidate. Required scope: `w_candidates`. Accessible with all token types. If an evaluation already exists for the given member on the given stage, it is updated. Otherwise, a new one is created. The stage defaults to the candidate's current stage when stage_id is not provided.
- [/candidates/:id/update_custom_attribute_value](https://workable.readme.io/reference/candidatesidupdate_custom_attribute_value.md): Updates a custom attribute value for a candidate. Required scope: `r_jobs`. Accessible with all token types.
- [/custom_attributes](https://workable.readme.io/reference/custom_attributes.md): Returns a collection of the account's custom attributes. Required scope: `r_jobs`. Accessible with all token types.
- [/events](https://workable.readme.io/reference/events.md): Returns a collection of events. Required scope: `r_jobs`. Accessible with account tokens and user tokens.
- [/events/:id](https://workable.readme.io/reference/events-show.md): Returns date for the identified event. Required scope: `r_jobs`. Accessible with account tokens and user tokens.
- [/employees](https://workable.readme.io/reference/employees.md): Returns a collection of your account employees. Required scope: `r_employees`.
- [/employee_fields](https://workable.readme.io/reference/employee_fields.md): Returns a collection of your account employee_fields. Required scope: `r_account`.
- [/employees/:id](https://workable.readme.io/reference/employeesid.md): 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.
- [/employees/:id/documents](https://workable.readme.io/reference/employeesiddocuments.md): Returns a collection of the uploaded and signed documents for a specific employee. Required scope: `r_employees`. Accessible with user level tokens and account level tokens that provide the member_id query param.
- [/employees/orgchart](https://workable.readme.io/reference/employees-orgchart.md): Returns org chart nodes for the account. Required scope: `r_employees`.
- [/work_schedules](https://workable.readme.io/reference/work_schedules.md): Returns a collection of your account work_schedules. Required scope: `r_account`.
- [/employees](https://workable.readme.io/reference/create-employee.md): Creates an employee for your account. Required scope: `w_employees`.
- [/employees/:id](https://workable.readme.io/reference/update-employee.md): Updates an existing employee. Required scope: `w_employees`.
- [/employees/:id/documents](https://workable.readme.io/reference/employeesiddocuments-1.md): Uploads a list of documents for a specific employee. Required scope: `w_employees`.
- [/timeoff/categories](https://workable.readme.io/reference/timeoffcategories.md): Lists the time off categories configured for your account. Required scope: `r_timeoff`.
- [/timeoff/requests](https://workable.readme.io/reference/timeoffrequests.md): Creates a new time off request. Required scope: `w_timeoff`.
- [/timeoff/requests](https://workable.readme.io/reference/timeoffrequests-1.md): Returns a collection of time off requests. Required scope: `r_timeoff`.
- [/timeoff/approvals/:key](https://workable.readme.io/reference/timeoffapprovals.md): Approves or rejects a pending time off approval. Required scope: `w_timeoff`.
- [/timeoff/balances](https://workable.readme.io/reference/timeoffbalances.md): Returns a collection of your time off balances concerning all time off categories. Required scope: `r_timeoff`.
- [/time-tracking/time-entries](https://workable.readme.io/reference/time-tracking-list-entries.md): Returns a paginated list of time entries. Required scope: `r_time_tracking`.
- [/time-tracking/employees/:id/time-entries](https://workable.readme.io/reference/time-tracking-create-entry.md): Creates a single time entry for the specified employee. Required scope: `w_time_tracking`.
- [/time-tracking/time-entries](https://workable.readme.io/reference/time-tracking-bulk-create.md): Bulk creates complete time entries for one or more employees (max 500). Required scope: `w_time_tracking`.
- [/time-tracking/employees/:id/time-entries/:uuid](https://workable.readme.io/reference/time-tracking-update-entry.md): Updates an existing time entry for the specified employee. Required scope: `w_time_tracking`.
- [/time-tracking/employees/:id/time-entries/:uuid](https://workable.readme.io/reference/time-tracking-archive-entry.md): Archives a time entry for the specified employee (soft-delete). Required scope: `w_time_tracking`.
- [/review-cycles/templates](https://workable.readme.io/reference/performance-review-templates-list.md): Returns the account's performance review master templates. Required scope: `r_reviews`.
- [/review-cycles/templates/:id](https://workable.readme.io/reference/performance-review-templates-get.md): Returns a single performance review master template by id. Required scope: `r_reviews`.
- [/review-cycles/templates](https://workable.readme.io/reference/performance-review-templates-create.md): Creates a performance review master template. Required scope: `w_reviews`.
- [Webhook Subscriptions - Candidates & Employees](https://workable.readme.io/reference/webhook-subscriptions-candidates-employees.md)
- [/subscriptions](https://workable.readme.io/reference/subscriptions.md): Retrieves a list with your active subscriptions. Required scope: `r_candidates` or `r_employees`. Accessible with all token types.
- [/subscriptions](https://workable.readme.io/reference/webhook-subscriptions.md): Subscribe to an event. Required scope: `r_candidates` or `r_employees`. Accessible with all token types.
- [/subscriptions/:id](https://workable.readme.io/reference/subscriptionsid.md): Unsubscribe from an event. Required scope: `r_candidates` or `r_employees`. Accessible with all token types.
- [Candidate Events](https://workable.readme.io/reference/candidate-events.md)
- [Employee Events](https://workable.readme.io/reference/employee-events.md)
- [api/accounts/:subdomain](https://workable.readme.io/reference/jobs-1.md): Returns a collection of the public jobs for an account
- [StackOne](https://workable.readme.io/reference/stackone.md): Integrate with Workable via StackOne