Greenhouse Tags API

openapi: 3.1.0
info:
  title: Greenhouse Assessment Partner ActivityFeed Tags API
  description: 'The Assessment Partner API defines the contract that assessment vendors implement so

    Greenhouse can list available tests, send a test to a candidate, and retrieve the

    candidate''s results. Endpoints are hosted by the partner (not Greenhouse) and are

    secured with HTTP Basic over HTTPS. Greenhouse may also receive PATCH callbacks from

    the partner with completed test status; otherwise it polls `test_status` hourly for

    up to 8 weeks. API keys must be fewer than 171 characters.

    '
  version: 1.0.0
  contact:
    name: Greenhouse Software
    url: https://www.greenhouse.com
    email: developers@greenhouse.io
servers:
- url: https://{partner_host}/{base_path}
  description: Partner-hosted endpoint
  variables:
    partner_host:
      default: partner.example.com
    base_path:
      default: greenhouse-assessment
security:
- BasicAuth: []
tags:
- name: Tags
  description: Candidate tags.
paths:
  /candidate_tags:
    get:
      tags:
      - Tags
      summary: List Candidate Tags
      operationId: listCandidateTags
      responses:
        '200':
          description: Tags.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    post:
      tags:
      - Tags
      summary: Create Candidate Tag
      operationId: createCandidateTag
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tag'
      responses:
        '201':
          description: Created.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /candidate_tags/{id}:
    parameters:
    - $ref: '#/components/parameters/Id'
    delete:
      tags:
      - Tags
      summary: Delete Candidate Tag
      operationId: deleteCandidateTag
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      responses:
        '204':
          description: Deleted.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /candidates/{id}/candidate_tags:
    parameters:
    - $ref: '#/components/parameters/Id'
    get:
      tags:
      - Tags
      summary: List Candidate Candidate Tags
      operationId: listCandidateCandidateTags
      responses:
        '200':
          description: Tags.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags:
      - Tags
      summary: Replace Candidate Tags
      operationId: replaceCandidateTags
      parameters:
      - $ref: '#/components/parameters/OnBehalfOf'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tag_ids:
                  type: array
                  items:
                    type: integer
      responses:
        '200':
          description: Replaced.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /candidates/{id}/candidate_tags/{tag_id}:
    delete:
      tags:
      - Tags
      summary: Remove Candidate Tag
      operationId: removeCandidateTag
      parameters:
      - $ref: '#/components/parameters/Id'
      - name: tag_id
        in: path
        required: true
        schema:
          type: integer
      - $ref: '#/components/parameters/OnBehalfOf'
      responses:
        '204':
          description: Removed.
        4XX:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: integer
    OnBehalfOf:
      name: On-Behalf-Of
      in: header
      required: false
      description: The ID of the Greenhouse user the request is being made on behalf of.
      schema:
        type: integer
  responses:
    ErrorResponse:
      description: Error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Tag:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic; the API key is Base64-encoded and used as the username (key must be <171 chars).