Workable Candidates API

openapi: 3.1.0
info:
  title: Workable Accounts Candidates 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: Candidates
paths:
  /jobs/{shortcode}/candidates:
    parameters:
    - in: path
      name: shortcode
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Create candidate on job
      operationId: createJobCandidate
      responses:
        '201':
          description: Created
  /candidates:
    get:
      tags:
      - Candidates
      summary: List candidates
      operationId: listCandidates
      responses:
        '200':
          description: OK
  /candidates/{id}:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Candidates
      summary: Get candidate
      operationId: getCandidate
      responses:
        '200':
          description: OK
    put:
      tags:
      - Candidates
      summary: Update candidate
      operationId: updateCandidate
      responses:
        '200':
          description: OK
  /candidates/{id}/comments:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Add candidate comment
      operationId: addCandidateComment
      responses:
        '201':
          description: Created
  /candidates/{id}/copy:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Copy candidate
      operationId: copyCandidate
      responses:
        '201':
          description: Created
  /candidates/{id}/disqualify:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Disqualify candidate
      operationId: disqualifyCandidate
      responses:
        '200':
          description: OK
  /candidates/{id}/revert:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Revert candidate disqualification
      operationId: revertCandidate
      responses:
        '200':
          description: OK
  /candidates/{id}/move:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Move candidate
      operationId: moveCandidate
      responses:
        '200':
          description: OK
  /candidates/{id}/relocate:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Relocate candidate
      operationId: relocateCandidate
      responses:
        '200':
          description: OK
  /candidates/{id}/ratings:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Add candidate rating
      operationId: addCandidateRating
      responses:
        '201':
          description: Created
    put:
      tags:
      - Candidates
      summary: Update candidate rating
      operationId: updateCandidateRating
      responses:
        '200':
          description: OK
  /candidates/{id}/tags:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Add candidate tags
      operationId: addCandidateTags
      responses:
        '201':
          description: Created
  /candidates/{id}/activities:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Candidates
      summary: Get candidate activities
      operationId: getCandidateActivities
      responses:
        '200':
          description: OK
  /candidates/{id}/files:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Candidates
      summary: Get candidate files
      operationId: getCandidateFiles
      responses:
        '200':
          description: OK
  /candidates/{id}/offer:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Candidates
      summary: Get candidate offer
      operationId: getCandidateOffer
      responses:
        '200':
          description: OK
  /candidates/{id}/update_custom_attribute_value:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    post:
      tags:
      - Candidates
      summary: Update candidate custom attribute value
      operationId: updateCandidateCustomAttributeValue
      responses:
        '200':
          description: OK
  /talent_pool/candidates:
    post:
      tags:
      - Candidates
      summary: Add to talent pool
      operationId: addToTalentPool
      responses:
        '201':
          description: Created
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.

        '