Greenhouse Tests API

openapi: 3.1.0
info:
  title: Greenhouse Assessment Partner ActivityFeed Tests 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: Tests
  description: Available tests offered by the partner.
paths:
  /list_tests:
    get:
      tags:
      - Tests
      summary: List Partner Tests
      description: Returns the catalog of tests this partner offers.
      operationId: listPartnerTests
      responses:
        '200':
          description: Tests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  partner_test_ids:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerTest'
components:
  schemas:
    PartnerTest:
      type: object
      properties:
        partner_test_id:
          type: string
        partner_test_name:
          type: string
        partner_test_description:
          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).