Greenhouse ActivityFeed API

openapi: 3.1.0
info:
  title: Greenhouse Assessment Partner ActivityFeed 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: ActivityFeed
  description: Per-candidate timeline of activity events.
paths:
  /candidates/{id}/activity_feed:
    get:
      tags:
      - ActivityFeed
      summary: List Candidate Activity Feed
      operationId: getCandidateActivityFeed
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Activity feed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityFeed'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
components:
  responses:
    ErrorResponse:
      description: Error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: integer
  schemas:
    ActivityFeed:
      type: object
      properties:
        activities:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              created_at:
                type: string
                format: date-time
              subject:
                type: string
              body:
                type: string
              user:
                $ref: '#/components/schemas/UserRef'
        notes:
          type: array
          items:
            type: object
        emails:
          type: array
          items:
            type: object
    UserRef:
      type: object
      nullable: true
      properties:
        id:
          type: integer
        first_name:
          type: string
        last_name:
          type: string
        name:
          type: string
        employee_id:
          type: string
          nullable: true
    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).