openapi: 3.0.1
info:
  title: Pinpoint Applicants Comments API
  description: REST API for the Pinpoint applicant tracking system (ATS) and recruitment platform. The API adheres to the JSON:API specification and is served on a per-tenant basis. All requests must be made over HTTPS to https://{subdomain}.pinpointhq.com/api/v1, where {subdomain} matches the subdomain used to log in to Pinpoint. Authentication uses an X-API-KEY header generated from Settings > API & Webhooks. Requests and responses use the application/vnd.api+json media type. Not to be confused with AWS Pinpoint (customer engagement messaging) or Pinpoint (signal / data intelligence).
  termsOfService: https://www.pinpointhq.com/legal/
  contact:
    name: Pinpoint Support
    url: https://developers.pinpointhq.com/docs/introduction
  version: '1.0'
servers:
- url: https://{subdomain}.pinpointhq.com/api/v1
  description: Per-tenant Pinpoint API base URL.
  variables:
    subdomain:
      default: acme
      description: The subdomain used to log in to your Pinpoint account.
security:
- ApiKeyAuth: []
tags:
- name: Comments
  description: Comments on applications.
paths:
  /comments:
    get:
      operationId: listComments
      tags:
      - Comments
      summary: List comments
      parameters:
      - $ref: '#/components/parameters/PageNumber'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Include'
      - name: filter[application_id]
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: A list of comments.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CommentCollection'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createComment
      tags:
      - Comments
      summary: Create comment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CommentSingleWrite'
      responses:
        '201':
          description: The created comment.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CommentSingle'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /comments/{id}:
    parameters:
    - $ref: '#/components/parameters/ResourceId'
    get:
      operationId: getComment
      tags:
      - Comments
      summary: Fetch comment
      responses:
        '200':
          description: The requested comment.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CommentSingle'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    CommentSingleWrite:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              example: comments
            attributes:
              $ref: '#/components/schemas/CommentAttributes'
            relationships:
              type: object
              additionalProperties: true
    PaginationMeta:
      type: object
      properties:
        total_count:
          type: integer
        page_count:
          type: integer
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
    CommentSingle:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Comment'
    CommentAttributes:
      type: object
      properties:
        body:
          type: string
        created_at:
          type: string
          format: date-time
    Comment:
      type: object
      properties:
        type:
          type: string
          example: comments
        id:
          type: string
        attributes:
          $ref: '#/components/schemas/CommentAttributes'
        relationships:
          type: object
          additionalProperties: true
    CommentCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
  parameters:
    PageNumber:
      name: page[number]
      in: query
      description: The page of results to return. Defaults to 1.
      schema:
        type: integer
        default: 1
    ResourceId:
      name: id
      in: path
      required: true
      description: The resource identifier.
      schema:
        type: string
    Include:
      name: include
      in: query
      description: Comma-separated list of relationship paths to side-load, with dot notation for nested relationships (JSON:API includes).
      schema:
        type: string
    PageSize:
      name: page[size]
      in: query
      description: Number of results per page (0-1000). Defaults to 100.
      schema:
        type: integer
        minimum: 0
        maximum: 1000
        default: 100
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
    UnprocessableEntity:
      description: Validation failed for the submitted resource.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API key generated in Settings > API & Webhooks > API Keys. Sent with every request as the X-API-KEY header. Missing or invalid keys return HTTP 401.