| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://{subdomain}.workable.com/spi/v3 | link | — | — | — |
Actions (73)
Recruiting · 40
- Add candidate commentPOST /candidates/{id}/comments
Creates a comment on a candidate's timeline.
documented - Add candidate ratingPOST /candidates/{id}/ratings
Adds a rating to a candidate.
documented - Add candidate to jobPOST /jobs/{shortcode}/candidates
Creates a candidate for a job.
documented - Add candidate to talent poolPOST /talent_pool/candidates
Adds a candidate to the talent pool.
documented - Approve offerPATCH /offers/{id}/approve
Approves an offer.
documented - Approve requisitionPATCH /requisitions/{code}/approve
Approves a requisition.
documented - Copy candidatePOST /candidates/{id}/copy
Creates a copy of a candidate.
documented - Create requisitionPOST /requisitions
Creates a new requisition.
documented - Disqualify candidatePOST /candidates/{id}/disqualify
Marks a candidate as disqualified.
documented - Get candidateGET /candidates/{id}
Returns a candidate by ID.
documented - Get candidate offerGET /candidates/{id}/offer
Returns the offer for a candidate.
documented - Get eventGET /events/{id}
Returns details for a specific event.
documented - Get job application formGET /jobs/{shortcode}/application_form
Returns application form details for a job.
documented - Get job by shortcodeGET /jobs/{shortcode}
Returns details for a job identified by shortcode.
documented - Get offerGET /offers/{id}
Returns the offer details for the given ID.
documented - Get requisitionGET /requisitions/{code}
Returns details for a specific requisition by code.
documented - List candidate activitiesGET /candidates/{id}/activities
Returns activities for a candidate.
documented - List candidate filesGET /candidates/{id}/files
Returns files associated with a candidate.
documented - List candidatesGET /candidates
Returns a collection of candidates.
documented - List custom attributesGET /custom_attributes
Returns custom attributes for jobs and candidates.
documented - List eventsGET /events
Returns events for the account.
documented - List job activitiesGET /jobs/{shortcode}/activities
Returns activity stream for a job.
documented - List job custom attributesGET /jobs/{shortcode}/custom_attributes
Returns custom attributes for a job.
documented - List job membersGET /jobs/{shortcode}/members
Returns members associated with a job.
documented - List job questionsGET /jobs/{shortcode}/questions
Returns questions for a job.
documented - List job recruitersGET /jobs/{shortcode}/recruiters
Returns recruiters associated with a job.
documented - List job stagesGET /jobs/{shortcode}/stages
Returns stages for a job.
documented - List jobsGET /jobs
Returns a list of jobs for the account.
documented - List recruitersGET /recruiters
Returns external recruiters associated with the account.
documented - List requisitionsGET /requisitions
Returns requisitions for the account.
documented - List stagesGET /stages
Returns recruitment pipeline stages for the account.
documented - Move candidatePOST /candidates/{id}/move
Moves a candidate within the pipeline.
documented - Reject offerPATCH /offers/{id}/reject
Rejects an offer.
documented - Reject requisitionPATCH /requisitions/{code}/reject
Rejects a requisition.
documented - Relocate candidatePOST /candidates/{id}/relocate
Relocates a candidate to another job/location.
documented - Revert candidate statusPOST /candidates/{id}/revert
Reverts a candidate's status.
documented - Update candidatePATCH /candidates/{id}
Partially updates a candidate.
documented - Update candidate custom attribute valuePATCH /candidates/{id}/update_custom_attribute_value
Updates a candidate's custom attribute value.
documented - Update candidate tagsPUT /candidates/{id}/tags
Updates tags on a candidate.
documented - Update requisitionPATCH /requisitions
Updates an existing requisition.
documented
HR · 12
- Create employeePOST /employees
Creates a new employee.
documented - Create time-off requestPOST /timeoff/requests
Creates a time-off request.
documented - Get employeeGET /employees/{id}
Returns an employee by ID.
documented - List employee documentsGET /employees/{id}/documents
Returns documents for an employee.
documented - List employee fieldsGET /employee_fields
Returns employee fields for the account.
documented - List employeesGET /employees
Returns a collection of employees.
documented - List time-off balancesGET /timeoff/balances
Returns time-off balances.
documented - List time-off categoriesGET /timeoff/categories
Returns time-off categories.
documented - List time-off requestsGET /timeoff/requests
Returns time-off requests.
documented - List work schedulesGET /work_schedules
Returns work schedules for the account.
documented - Update employeePATCH /employees/{id}
Updates an employee.
documented - Upload employee documentPOST /employees/{id}/documents
Adds a document to an employee.
documented
Accounts · 5
- Get account by subdomainGET /accounts/{subdomain}
Returns the account identified by the given subdomain.
documented - List accountsGET /accounts
Returns a collection of accounts the authenticated user can access.
documented - List disqualification reasonsGET /disqualification_reasons
Returns disqualification reasons for candidates.
documented - List legal entitiesGET /legal_entities
Returns the account's legal entities.
documented - List permission setsGET /permission_sets
Returns the account's permission sets.
documented
Departments · 5
- Create departmentPOST /departments
Creates a new department in the account.
documented - Delete departmentDELETE /departments/{id}
Deletes a department.
documented - List departmentsGET /departments
Returns departments for the account.
documented - Merge departmentsPOST /departments/{id}/merge
Merges the specified department with another department.
documented - Update departmentPUT /departments
Updates an existing department.
documented
Members · 5
- Delete memberDELETE /members/{id}
Deactivates a member.
documented - Enable memberPOST /members/{id}/enable
Restores a deactivated member.
documented - Invite memberPOST /members/invite
Invites a new member to the account.
documented - List membersGET /members
Returns a collection of members in the account.
documented - Update memberPUT /members
Updates a member in the account.
documented
Public Endpoints · 3
- Get public account by subdomainGET /api/accounts/{subdomain}
Returns the public account for a given subdomain.
documented - List public departmentsGET /api/accounts/{subdomain}/departments
Returns public departments for an account.
documented - List public locationsGET /api/accounts/{subdomain}/locations
Returns public locations for an account.
documented