Workable Employees API

openapi: 3.1.0
info:
  title: Workable Accounts Employees API
  description: 'REST API for Workable''s recruiting and HR platform — manage jobs, candidates,

    employees, departments, members, offers, requisitions, time tracking, time off,

    review cycles, and subscriptions.

    '
  version: 3.21.0
  contact:
    name: Workable
    url: https://workable.readme.io/
servers:
- url: https://{subdomain}.workable.com/spi/v3
  description: Workable API
  variables:
    subdomain:
      default: example
      description: Workable account subdomain
security:
- bearerAuth: []
tags:
- name: Employees
paths:
  /employees:
    get:
      tags:
      - Employees
      summary: List employees
      operationId: listEmployees
      responses:
        '200':
          description: OK
    post:
      tags:
      - Employees
      summary: Create employee
      operationId: createEmployee
      responses:
        '201':
          description: Created
  /employees/{id}:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Employees
      summary: Get employee
      operationId: getEmployee
      responses:
        '200':
          description: OK
    put:
      tags:
      - Employees
      summary: Update employee
      operationId: updateEmployee
      responses:
        '200':
          description: OK
  /employees/orgchart:
    get:
      tags:
      - Employees
      summary: Get organization chart
      operationId: getOrgChart
      responses:
        '200':
          description: OK
  /employees/{id}/documents:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Employees
      summary: List employee documents
      operationId: listEmployeeDocuments
      responses:
        '200':
          description: OK
    post:
      tags:
      - Employees
      summary: Upload employee document
      operationId: uploadEmployeeDocument
      responses:
        '201':
          description: Created
  /employee_fields:
    get:
      tags:
      - Employees
      summary: List employee fields
      operationId: listEmployeeFields
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Workable API token authentication using Bearer token in Authorization header.

        Token types include account tokens, user tokens, and API access tokens.

        '