openapi.yaml

openapi: 3.0.1
info:
  title: Fountain Public API
  description: >-
    Fountain's all-in-one high volume hiring platform empowers the world's
    leading enterprises to find the right people through smart, fast, and
    seamless recruiting. Candidates can apply anytime, anywhere in minutes,
    right from their phone. Automated and customizable processes streamline the
    candidate experience and save time for recruitment teams so they can scale
    with growing hiring needs. Advanced analytics provide end-to-end process
    visibility so managers can make swift, data-driven decisions. Throughout the
    candidate journey, the openly integrated platform enables companies to find,
    qualify and convert more applicants. Fountain's global customers hire over
    1.2 million workers annually in 78 countries.


    Why Work with Us:


    - Generous compensation, San Francisco rate compensation regardless of
    location in US

    - 100% Remote and Flexible Hours

    - Unlimited PTO

    - Equity grants

    - Comprehensive healthcare benefits

    - 16 weeks paid parental leave for all parents

    - Wellness and gym reimbursement

    - Home office stipend

    - Phone stipend

    - 401K plan

    - Learning and development reimbursement

    - Company events

    - FSA & HSA

    - Life Insurance & Long-Term Disability/Short-Term Disability


    Visit us at https://get.fountain.com to learn more.
  version: v2
  x-konfig-ignore:
    potential-incorrect-type: true
servers:
  - description: Our production API url.
    url: https://api.fountain.com
tags:
  - name: Applicants
  - name: Locations and Location Groups
  - name: Export Management
  - name: Openings and Stages
  - name: Option Bank
  - name: Calendar Slots
  - name: Positions
  - name: Posthire Worker Management
  - name: Notes
  - name: Hiring Goals
  - name: Labels
  - name: Users
  - name: Workflows
  - name: Data Keys
  - name: Openings
  - name: Shifts
paths:
  /v2/applicants:
    get:
      tags:
        - Applicants
      summary: List All Applicants
      operationId: Applicants_listAll
      description: List all applicants within your account.
      parameters:
        - name: funnel_id
          in: query
          required: false
          schema:
            type: string
        - name: location_id
          in: query
          required: false
          schema:
            type: string
        - name: stage_id
          in: query
          required: false
          schema:
            type: string
        - name: stage
          in: query
          required: false
          schema:
            type: string
        - name: labels
          in: query
          required: false
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: created_at
          in: query
          required: false
          schema:
            type: string
        - name: last_transitioned_at
          in: query
          required: false
          schema:
            type: string
        - name: updated_at
          in: query
          required: false
          schema:
            type: string
        - description: >-
            The key of the custom data field to filter by. Used with
            `custom_data_field[value]`. Must also use one of created_at,
            last_transitioned_at, updated_at, stage_id, or funnel_id. Does not
            support secure fields or standard questions.
          name: custom_data_field[key]
          in: query
          required: false
          schema:
            type: string
        - description: >-
            The value of the custom data field to filter by. Used with
            `custom_data_field[key]`.
          name: custom_data_field[value]
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Applicants'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Applicants
      summary: Create an Applicant
      operationId: Applicants_createNewApplicant
      description: Create an applicant within your account.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApplicantRequest'
        required: true
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Applicant'
  /v2/applicants/{id}:
    get:
      tags:
        - Applicants
      summary: Get Applicant Info
      operationId: Applicants_getInfo
      description: Get an applicant's data as it is stored in Fountain.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Applicant'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    put:
      tags:
        - Applicants
      summary: Update Applicant Info
      operationId: Applicants_updateInfo
      description: Update an applicant's information
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsUpdateInfoRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Applicant'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    delete:
      tags:
        - Applicants
      summary: Delete an Applicant
      operationId: Applicants_deleteById
      description: Delete an applicant by their ID.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantsDeleteByIdResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/advance:
    put:
      tags:
        - Applicants
      summary: Advance an Applicant
      operationId: Applicants_advanceApplicant
      description: >-
        Move an applicant to an appropriate stage or to the next stage
        (default).
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsAdvanceApplicantRequest'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/advance:
    post:
      tags:
        - Applicants
      summary: Bulk Advance Multiple Applicants
      operationId: Applicants_bulkAdvanceMultiple
      description: >-
        Move an applicant to an appropriate stage or to the next stage
        (default).
      parameters:
        - description: >-
            Destination stage's external id. All specified applicants will
            advance to this stage.
          name: stage_id
          in: query
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsBulkAdvanceMultipleRequest'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/transitions:
    get:
      tags:
        - Applicants
      summary: Get Transition History
      operationId: Applicants_getTransitionHistory
      description: Returns the transition history of an applicant.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantTransitionHistoryResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/transitions:
    post:
      tags:
        - Applicants
      summary: Bulk Transition History for Multiple Applicants
      operationId: Applicants_bulkTransitionHistory
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsBulkTransitionHistoryRequest'
      responses:
        '200':
          description: No Content
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/MultipleApplicantsTransitionHistoryResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/booked_slots:
    get:
      tags:
        - Applicants
      summary: Get Interview Sesssions
      operationId: Applicants_getInterviewSessions
      description: Returns the applicants interview sessions.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantBookeSlotResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/booked_slots:
    post:
      tags:
        - Applicants
      summary: Bulk Interview Sessions for Multiple Applicants
      operationId: Applicants_bulkInterviewSessions
      description: >-
        Move an applicant to an appropriate stage or to the next stage
        (default).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsBulkInterviewSessionsRequest'
      responses:
        '200':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultipleApplicantsBookedSlotResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/labels:
    get:
      tags:
        - Labels
      summary: List Labels for Applicant
      operationId: Labels_listForApplicant
      description: This lists all labels for an applicant.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Labels'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/labels/{title}:
    put:
      tags:
        - Labels
      summary: Update Label for Applicant
      operationId: Labels_updateForApplicant
      description: >-
        This method updates a list of labels for an applicant. Use it to delete
        existing labels for an applicant or add new ones.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: title
          in: path
          required: true
          schema:
            type: string
        - name: completed
          in: query
          required: false
          schema:
            type: boolean
        - name: completed_at
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Labels'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/notes:
    get:
      tags:
        - Notes
      summary: Get Applicant Notes
      operationId: Notes_getApplicant
      description: Accessing Applicant Notes
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantNotesResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Notes
      summary: Create Applicant Note
      operationId: Notes_createApplicantNote
      description: Creating Applicant Notes
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUpdateApplicantNote'
        required: true
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantNote'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/notes/{note_id}:
    delete:
      tags:
        - Notes
      summary: Delete Applicant Note
      operationId: Notes_deleteApplicantNote
      description: Deleting an Applicant Note
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: note_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotesDeleteApplicantNoteResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    put:
      tags:
        - Notes
      summary: Update Applicant Note
      operationId: Notes_updateApplicantNote
      description: Updating Applicant Note
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: note_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUpdateApplicantNote'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantNote'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/secure_documents:
    get:
      tags:
        - Applicants
      summary: Get Applicant Files
      operationId: Applicants_getSecureDocuments
      description: Accessing secure file uploads from Fountain
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantSecureDocumentsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/secure_documents/upload:
    post:
      tags:
        - Applicants
      summary: File Upload to S3
      operationId: Applicants_uploadSecureDocumentToS3
      description: Accessing secure file uploads from Fountain
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsUploadSecureDocumentToS3Request'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantSecureDocumentUploadResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/applicants/{id}/secure_documents/link_upload:
    post:
      tags:
        - Applicants
      summary: Link Applicant to Files in S3
      operationId: Applicants_linkUpload
      description: Accessing secure file uploads from Fountain
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicantsLinkUploadRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicantSecureDocumentLinkUploadResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/available_slots:
    post:
      tags:
        - Calendar Slots
      summary: Create Calendar Slots
      operationId: CalendarSlots_createNewAvailable
      description: Create a new available slot
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalendarSlotsCreateNewAvailableRequest'
        required: true
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarSlotsCreateNewAvailableResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/available_slots/{id}/confirm:
    post:
      tags:
        - Calendar Slots
      summary: Book an Available Slot
      operationId: CalendarSlots_confirmBooking
      description: Book an available slot with an applicant
      parameters:
        - description: The Available Slot ID
          name: id
          in: path
          required: true
          schema:
            type: string
        - description: >-
            The unique identifier for the applicant to be associated with the
            booked slot
          name: applicant_id
          in: query
          schema:
            type: string
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BookedSlot'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/available_slots/{id}:
    delete:
      tags:
        - Calendar Slots
      summary: Delete Calendar Slots
      operationId: CalendarSlots_destroyById
      description: Destroy calendar slot by the unique identifier
      parameters:
        - description: The Available Slot ID
          name: id
          in: path
          required: true
          schema:
            type: string
        - description: If set, will destroy all slots with the same key
          name: delete_all_siblings
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarSlotsDestroyByIdResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/booked_slots/{id}/cancel:
    post:
      tags:
        - Calendar Slots
      summary: Cancel a booked slot
      operationId: CalendarSlots_cancelSlot
      description: Cancel a booked slot
      parameters:
        - description: Identifier of the booked slot to cancel
          name: id
          in: path
          required: true
          schema:
            type: string
        - description: The page of results to view
          name: page
          in: query
          required: false
          schema:
            type: integer
      responses:
        '204':
          description: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/data_keys:
    get:
      tags:
        - Data Keys
      summary: List data keys
      operationId: DataKeys_list
      description: List all data keys on the account. Supports pagination.
      parameters:
        - description: The page of results to retrieve.
          name: page
          in: query
          required: false
          schema:
            type: integer
        - description: >-
            The number of results to retrieve per page. The endpoint returns 20
            results per page by default.
          name: per_page
          in: query
          required: false
          schema:
            type: integer
        - description: >-
            A filter to limit which data_keys will be returned based on the
            last_updated_at data on the data_key.
          name: updated_at
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataKeysListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/exports:
    get:
      tags:
        - Export Management
      summary: List all Custom Exports
      operationId: ExportManagement_listCustomExports
      description: List all Custom Exports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexExportResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Export Management
      summary: Create Custom Export
      operationId: ExportManagement_createCustomExport
      description: Creating Custom Export
      parameters:
        - name: template_id
          in: query
          required: true
          schema:
            type: string
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShowExportResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/exports/{id}:
    get:
      tags:
        - Export Management
      summary: Download Custom Export
      operationId: ExportManagement_downloadCustomExport
      description: Download Custom Export
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShowExportResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/exports/templates:
    get:
      tags:
        - Export Management
      summary: List all Custom Export Templates
      operationId: ExportManagement_listCustomTemplates
      description: List all Custom Export Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexExportTemplatesResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/funnels:
    get:
      tags:
        - Openings and Stages
      summary: List All Openings
      operationId: OpeningsAndStages_listAll
      description: >-
        List all Opening(s) within your account. Funnel is used interchangeably
        with Opening. Each Opening contains information on address, stages in
        the funnel, location, active status, etc. Check the example to see all
        properties available.
      parameters:
        - description: The page of results to view
          name: page
          in: query
          schema:
            type: integer
        - description: The number of results to return per page
          name: per_page
          in: query
          schema:
            type: integer
        - description: The field by which to sort results
          name: sort_by
          in: query
          schema:
            type: string
        - description: The direction in which results are sorted
          name: sort_direction
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
        - description: Filter by whether the opening is active or not
          name: active
          in: query
          schema:
            type: boolean
        - description: Filter by the name of the brand
          name: brand_name
          in: query
          schema:
            type: string
        - description: Filter by the address associated with the opening
          name: location_address
          in: query
          schema:
            type: string
        - description: Filter by the name of the location associated with the opening
          name: location_name
          in: query
          schema:
            type: string
        - description: Filter by the name of the location group associated with the opening
          name: location_group_name
          in: query
          schema:
            type: string
        - description: Text-based query of the opening attributes
          name: query
          in: query
          schema:
            type: string
        - description: Filter by the name of the shift associated with the opening
          name: shift_name
          in: query
          schema:
            type: string
        - description: Filter by the days of the shift associated with the opening
          name: shift_days[]
          in: query
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
              enum:
                - mon
                - tue
                - wed
                - thu
                - fri
                - sat
                - sun
        - description: >-
            Filter by the start time of the shift associated with the opening
            using the 24 hour clock (i.e. 10 PM is 2200)
          name: shift_start_time
          in: query
          schema:
            type: string
        - description: >-
            Filter by the end time of the shift associated with the opening
            using the 24 hour clock (i.e. 10 PM is 2200)
          name: shift_end_time
          in: query
          schema:
            type: string
        - description: Filter by the sourcing type of the opening
          name: sourcing_purchase_type
          in: query
          schema:
            type: string
            enum:
              - standard
              - indeed_campaign
        - description: Filter by the title of the opening
          name: title
          in: query
          schema:
            type: string
        - description: Filter for funnels updated after this
          name: updated_at_gt
          in: query
          schema:
            type: string
        - description: Filter for funnels updated before this
          name: updated_at_lt
          in: query
          schema:
            type: string
        - description: Filter to account owner
          name: user_openings
          in: query
          schema:
            type: boolean
        - description: Filter for funnels with a specific workflow identifier
          name: workflow_id
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpeningsAndStagesListAllResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Openings and Stages
      summary: Create a new opening
      operationId: OpeningsAndStages_createOpening
      description: Create a new Opening
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpeningsAndStagesCreateOpeningRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Funnel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/funnels/{id}:
    get:
      tags:
        - Openings and Stages
      summary: Retrieve Opening
      operationId: OpeningsAndStages_getOpeningById
      description: Find a specific Opening by the unique identifier.
      parameters:
        - description: The Opening ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Funnel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    put:
      tags:
        - Openings and Stages
      summary: Update opening
      operationId: OpeningsAndStages_updateOpening
      description: Update an existing Opening
      parameters:
        - description: The Opening ID
          name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpeningsAndStagesUpdateOpeningRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Funnel'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    delete:
      tags:
        - Openings and Stages
      summary: Delete an opening
      operationId: OpeningsAndStages_deleteOpening
      description: Delete an existing Opening
      parameters:
        - description: The Opening ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/hiring_goals:
    get:
      tags:
        - Hiring Goals
      summary: List Hiring Goals
      operationId: HiringGoals_listGoals
      description: >-
        List all Hiring Goals within your account. Check the example to see all
        properties available.
      parameters:
        - description: Filter by a particular Opening (also known as Funnel)
          name: opening_id
          in: query
          schema:
            type: integer
        - description: The page of results to view
          name: page
          in: query
          schema:
            type: integer
        - description: The number of results to return per page
          name: per_page
          in: query
          schema:
            type: integer
        - description: The field by which to sort results
          name: sort_by
          in: query
          schema:
            type: string
        - description: The direction in which results are sorted
          name: sort_direction
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
        - description: Filter by the Hiring Goal status
          name: status
          in: query
          schema:
            type: string
            enum:
              - unfilled
              - filled
        - description: >-
            Filter to current Hiring Goals. Current is defined by Hiring Goals
            with a `hire_by` date greater and or equal to today.
          name: current
          in: query
          schema:
            type: boolean
        - description: >-
            Filter to past Hiring Goals. Current is defined by Hiring Goals with
            a `hire_by` date before today.
          name: past
          in: query
          schema:
            type: boolean
        - description: >-
            Filter to open Hiring Goals. Open Hiring Goals are Hiring Goals who
            have not been closed (`closed_at == nil`)
          name: open
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HiringGoalsListGoalsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '501':
          description: NotImplemented
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplemented'
    post:
      tags:
        - Hiring Goals
      summary: Create a new hiring goal
      operationId: HiringGoals_createNewGoal
      description: Create a new Hiring Goal
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HiringGoalsCreateNewGoalRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HiringGoal'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '501':
          description: NotImplemented
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplemented'
  /v2/hiring_goals/{id}:
    put:
      tags:
        - Hiring Goals
      summary: Update Hiring Goal
      operationId: HiringGoals_updateExistingGoal
      description: Update an existing Hiring Goal
      parameters:
        - description: The Hiring Goal ID
          name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HiringGoalsUpdateExistingGoalRequest'
        required: true
      responses:
        '202':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HiringGoal'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '501':
          description: NotImplemented
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplemented'
    delete:
      tags:
        - Hiring Goals
      summary: Delete a Hiring Goal
      operationId: HiringGoals_deleteGoal
      description: Delete an existing Hiring Goal
      parameters:
        - description: The Hiring Goal ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '501':
          description: NotImplemented
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotImplemented'
  /v2/location_groups:
    get:
      tags:
        - Locations and Location Groups
      summary: List Location Groups
      operationId: LocationsAndLocationGroups_list
      description: >-
        List all Location Groups within your account. Check the example to see
        all properties available.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationsAndLocationGroupsListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Locations and Location Groups
      summary: Create a new Location Group
      operationId: LocationsAndLocationGroups_createLocationGroup
      description: Create a new Location Group
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/LocationsAndLocationGroupsCreateLocationGroupRequest
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationGroupDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/location_groups/{id}:
    get:
      tags:
        - Locations and Location Groups
      summary: Retrieve Location Group
      operationId: LocationsAndLocationGroups_getLocationGroup
      description: Find a specific Location Group by the unique identifier.
      parameters:
        - description: The Location Group ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationGroupDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    put:
      tags:
        - Locations and Location Groups
      summary: Update Location Group
      operationId: LocationsAndLocationGroups_updateLocationGroup
      description: Update an existing Location Group
      parameters:
        - description: The Location Group ID
          name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/LocationsAndLocationGroupsUpdateLocationGroupRequest
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationGroupDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    delete:
      tags:
        - Locations and Location Groups
      summary: Delete a Location Group
      operationId: LocationsAndLocationGroups_deleteLocationGroup
      description: Delete an existing Location Group
      parameters:
        - description: The Location Group ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/locations:
    get:
      tags:
        - Locations and Location Groups
      summary: List Locations
      operationId: LocationsAndLocationGroups_listLocations
      description: >-
        List all Locations within your account. Check the example to see all
        properties available.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/LocationsAndLocationGroupsListLocationsResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Locations and Location Groups
      summary: Create a new Location
      operationId: LocationsAndLocationGroups_createNewLocation
      description: Create a new Location
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertLocationParams'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/locations/{id}:
    get:
      tags:
        - Locations and Location Groups
      summary: Retrieve Location
      operationId: LocationsAndLocationGroups_getLocationById
      description: Find a specific Location by the unique identifier.
      parameters:
        - description: The Location ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    put:
      tags:
        - Locations and Location Groups
      summary: Update Location
      operationId: LocationsAndLocationGroups_updateLocation
      description: Update an existing Location
      parameters:
        - description: The Location ID
          name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertLocationParams'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    delete:
      tags:
        - Locations and Location Groups
      summary: Delete a Location
      operationId: LocationsAndLocationGroups_deleteLocation
      description: Delete an existing Location
      parameters:
        - description: The Location ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /api/v2/openings/workflow_reassignment:
    post:
      tags:
        - Openings
      summary: Reassign Opening to Different Workflow (Alpha)
      operationId: Openings_reassignToWorkflow
      description: >-
        Takes a stage mapping array to move applicants from one stage to
        another.  The stage mapping array is an array of hashes with the keys
        "source" and "destination".  The "source" key is the name of the stage
        in the source workflow, and the "destination" key is the name of the
        stage in the destination workflow. This feature is in Alpha, meaning
        that explicit flags must be set for this endpoint to behave as expected.
        If you are interested in trying this API, please reach out to your
        account representative for more information.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpeningsReassignToWorkflowRequest'
        required: true
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
  /v2/option_banks/{id}:
    get:
      tags:
        - Option Bank
      summary: Get Option Bank
      operationId: OptionBank_getOptionBankById
      description: Show an Option Banks
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsBankWithOptions'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    put:
      tags:
        - Option Bank
      summary: Replace Option Bank
      operationId: OptionBank_replaceBank
      description: Show an Option Banks
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOptionBankRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsBankWithOptions'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    delete:
      tags:
        - Option Bank
      summary: Delete Option Bank
      operationId: OptionBank_deleteBank
      description: Show an Option Banks
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionBankDeleteBankResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/option_banks/{id}/remove:
    delete:
      tags:
        - Option Bank
      summary: Remove from Option Bank
      operationId: OptionBank_removeOption
      description: Remove an Option Bank Option
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: options
          in: query
          required: true
          schema:
            type: object
            properties:
              options:
                type: array
                items:
                  type: object
                  properties:
                    label:
                      description: Display name for the Option Bank
                      type: string
                    value:
                      description: Value for the Option Bank
                      type: string
                  required:
                    - label
                    - value
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionBankRemoveOptionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/option_banks/{id}/append:
    put:
      tags:
        - Option Bank
      summary: Append to Option Bank
      operationId: OptionBank_appendOption
      description: Remove an Option Bank Option
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: options
          in: query
          required: true
          schema:
            type: object
            properties:
              options:
                type: array
                items:
                  type: object
                  properties:
                    label:
                      description: Display name for the Option Bank
                      type: string
                    value:
                      description: Value for the Option Bank
                      type: string
                  required:
                    - label
                    - value
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionBankAppendOptionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/positions:
    get:
      tags:
        - Positions
      summary: List Positions
      operationId: Positions_listAll
      description: >-
        List all Positions within your account. Check the example to see all
        properties available.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PositionsListAllResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    post:
      tags:
        - Positions
      summary: Create a new Position
      operationId: Positions_createNewPosition
      description: Create a new Position
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PositionsCreateNewPositionRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PositionDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/positions/{id}:
    get:
      tags:
        - Positions
      summary: Retrieve Position
      operationId: Positions_getById
      description: Find a specific Position by the unique identifier.
      parameters:
        - description: The Position ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PositionDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    put:
      tags:
        - Positions
      summary: Update Position
      operationId: Positions_updateExistingPosition
      description: Update an existing Position
      parameters:
        - description: The Position ID
          name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PositionsUpdateExistingPositionRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PositionDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    delete:
      tags:
        - Positions
      summary: Delete a Position
      operationId: Positions_deletePosition
      description: Delete an existing Position
      parameters:
        - description: The Position ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/sessions:
    get:
      tags:
        - Calendar Slots
      summary: List calendar slots
      operationId: CalendarSlots_listBooked
      description: >-
        List all booked slots for an account. Option to include unbooked slots
        as well. Supports filtering on opening and stage as well as pagination
      parameters:
        - description: Identifier of opening to filter calendar slots on
          name: funnel_id
          in: query
          required: false
          schema:
            type: string
        - description: Indicates whether to include available slots in response
          name: with_unbooked
          in: query
          required: false
          schema:
            type: boolean
        - description: Identifier of stage to filter slots on
          name: stage_id
          in: query
          required: false
          schema:
            type: string
        - description: Cursor for the next page to view
          name: cursor
          in: query
          required: false
          schema:
            type: string
        - description: >-
            Filter by date, options are past, upcoming, a specific date with
            date=, or a date range with range=
          name: time
          in: query
          required: false
          schema:
            type: string
        - description: >-
            The page results to retrieve. The endpoint returns 10 results per
            page. Use the cursor option to view very old results.
          name: page
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarSlotsListBookedResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/shifts:
    get:
      tags:
        - Shifts
      summary: List shifts
      operationId: Shifts_listShifts
      description: List all shifts on the account. Supports pagination.
      parameters:
        - description: The page of results to retrieve.
          name: page
          in: query
          required: false
          schema:
            type: integer
        - description: >-
            The number of results to retrieve per page. The endpoint returns 20
            results per page by default.
          name: per_page
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShiftsListShiftsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/stages/{id}/available_slots:
    get:
      tags:
        - Calendar Slots
      summary: List available slots
      operationId: CalendarSlots_getAvailableSlots
      description: List all available slots for a given stage
      parameters:
        - description: Identifier of stage to list available slots for
          name: id
          in: path
          required: true
          schema:
            type: string
        - description: The page of results to view
          name: page
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarSlotsGetAvailableSlotsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/stages/{stage_id}/labels:
    get:
      tags:
        - Labels
      summary: List All Labels in Stage
      operationId: Labels_listInStage
      description: This method lists all the labels that are available in a specific stage.
      parameters:
        - name: stage_id
          in: path
          required: true
          schema:
            type: string
        - name: funnel_id
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Labels'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/funnels/{funnel_id}/stages:
    get:
      tags:
        - Openings and Stages
      summary: List All Opening Stages
      operationId: OpeningsAndStages_listOpeningStages
      description: Retrieves an Opening's stages
      parameters:
        - description: The Opening ID
          name: funnel_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/OpeningsAndStagesListOpeningStagesResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/stages/{id}:
    get:
      tags:
        - Openings and Stages
      summary: Retrieve stage
      operationId: OpeningsAndStages_getStage
      description: Retrieves a specific Stage
      parameters:
        - description: The Stage ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/timestamped_exports/templates:
    get:
      tags:
        - Export Management
      summary: List All Timestamped Export Templates
      operationId: ExportManagement_listTimestampedExportTemplates
      description: List All Timestamped Export Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexTimestampedExportTemplateResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/timestamped_exports/{id}:
    get:
      tags:
        - Export Management
      summary: Download Timestamped Export
      operationId: ExportManagement_downloadTimestampedExport
      description: Download Timestamped Export
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShowTimestampedExportResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/timestamped_exports:
    post:
      tags:
        - Export Management
      summary: Create Timestamped Exports
      operationId: ExportManagement_createTimestampedExports
      description: Create Timestamped Exports
      parameters:
        - name: template_id
          in: query
          required: true
          schema:
            type: string
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShowTimestampedExportResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
    get:
      tags:
        - Export Management
      summary: List all Timestamped Exports
      operationId: ExportManagement_listAllTimestampedExports
      description: List all Timestamped Exports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexTimestampedExportResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/user_activities/{id}:
    get:
      tags:
        - Users
      summary: Get User Activities
      operationId: Users_getActivities
      description: Accessing a users activities
      parameters:
        - description: The User ID
          name: id
          in: path
          required: true
          schema:
            type: string
        - description: Start must be within 30 days of End Time
          name: start_time
          in: query
          required: true
          example: '2024-01-01T12:00:00-05:00'
          schema:
            type: string
        - description: The end date of the activities
          name: end_time
          in: query
          required: true
          schema:
            type: string
        - description: The key describing the activity
          name: activity_type
          in: query
          example: stage.transitioned
          schema:
            type: string
        - description: ''
          name: per_page
          in: query
          schema:
            type: integer
        - description: ''
          name: page
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersGetActivitiesResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/users:
    get:
      tags:
        - Users
      summary: Get Users
      operationId: Users_listAccessedAll
      description: Accessing all account users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersListAccessedAllResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/workers:
    get:
      tags:
        - Posthire Worker Management
      summary: Get Workers
      operationId: PosthireWorkerManagement_listWorkers
      description: List all workers within your account
      parameters:
        - description: The opening ID
          name: funnel_id
          in: query
          schema:
            type: string
        - description: ''
          name: is_active
          in: query
          schema:
            type: boolean
        - description: Optional integer to indicate the page of pagination
          name: page
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosthireWorkerManagementListWorkersResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/workers/{id}:
    get:
      tags:
        - Posthire Worker Management
      summary: Get A Worker
      operationId: PosthireWorkerManagement_getWorkerData
      description: Get worker data
      parameters:
        - description: The Worker ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosthireWorkerManagementGetWorkerDataResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
    patch:
      tags:
        - Posthire Worker Management
      summary: Update A Worker
      operationId: PosthireWorkerManagement_updateWorker
      description: Update a worker
      parameters:
        - description: The Worker ID
          name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PosthireWorkerManagementUpdateWorkerRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PosthireWorkerManagementUpdateWorkerResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/workers/{id}/activate:
    post:
      tags:
        - Posthire Worker Management
      summary: Activate A Worker
      operationId: PosthireWorkerManagement_activateWorker
      description: >-
        Updates workers is_active attribute to true and marks worker as
        'Activated' in Posthire. Reapplies recurring checks
      parameters:
        - description: The Worker ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /v2/workers/{id}/deactivate:
    post:
      tags:
        - Posthire Worker Management
      summary: Deactivate A Worker
      operationId: PosthireWorkerManagement_deactivateWorker
      description: >-
        Updates workers is_active attribute to false and marks worker as
        'Deactivated' in Posthire. Cancels all active recurring checks and
        follow-up messages for this applicant.
      parameters:
        - description: The Worker ID
          name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
  /api/v2/workflows:
    get:
      tags:
        - Workflows
      summary: List all Workflows
      operationId: Workflows_getAllWorkflows
      description: List all Workflows in an Account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowsIndexResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /api/v2/workflows/{id}:
    delete:
      tags:
        - Workflows
      summary: Delete a Workflow
      operationId: Workflows_deleteWorkflow
      description: Delete a Workflow in an Account
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '202':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
  /v2/option_banks:
    get:
      tags:
        - Option Bank
      summary: List All Option Banks
      operationId: OptionBank_listAllBanks
      description: application/json
      parameters:
        - description: Optional integer to indicate the page of pagination
          name: page
          in: query
          schema:
            type: string
        - description: Optional integer to define page size for pagination
          name: per_page
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
    post:
      tags:
        - Option Bank
      summary: Create Option Bank
      operationId: OptionBank_createApplicantNotes
      description: Creating Applicant Notes
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOptionBankRequest'
        required: true
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsBankWithOptions'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-ACCESS-TOKEN
      in: header
  schemas:
    Applicants:
      type: object
      properties:
        applicants:
          type: array
          items:
            type: object
            properties:
              id:
                description: Applicants ID
                type: string
                example: 6e6f5eee-abbe-4ccb-8f12-894842bbe252
              email:
                description: Applicants Email Address
                type: string
                example: example@applicant.com
              name:
                description: Applicants Full Name
                type: string
                example: Michael Jordan
              first_name:
                description: Applicants First Name
                type: string
                example: Michael
              last_name:
                description: Applicants Last Name
                type: string
                example: Jordan
              phone_number:
                description: Applicants Phone Number
                type: string
                example: 214-609-0494
              normalized_phone_number:
                description: Applicants Phone Number
                type: string
                example: '+12146090494'
              phone_number_country_code:
                description: Applicants Phone Number country code
                type: string
                example: '+1'
              data:
                description: Applicant extra information
                type: object
              created_at:
                description: Date when the Applicant was created
                type: string
                format: date-time
                example: '2024-01-10T05:19:37.788-08:00'
              updated_at:
                description: Date when the Applicant was last updated
                type: string
                format: date-time
                example: '2024-01-10T05:19:37.293-08:00'
                nullable: true
              receive_automated_emails:
                description: Whether the Applciant receives automated emails or not.
                type: boolean
                example: true
              labels:
                type: array
                items:
                  type: object
                  properties:
                    title:
                      description: Name of the Label
                      type: string
                      example: Completed Survey
                    completed:
                      description: Was the label marked as done.
                      type: boolean
                      example: true
                    completed_at:
                      description: DateTime the Label was marked as done.
                      type: string
                      format: date-time
                      example: '2023-09-21T17:00:00.000-07:00'
                  required:
                    - title
                    - completed
                    - completed_at
              is_duplicate:
                description: Applicants has been marked as a duplicate.
                type: boolean
                example: false
              file_upload_requests:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      description: ID of the file upload request.
                      type: number
                      example: 1
                    recollection_reason:
                      description: Reason it is being recollected.
                      type: string
                      enum:
                        - blurry
                        - corrupt
                        - incorrect
                        - expired
                        - custom
                    created_at:
                      description: Date when the File Upload Request was created
                      type: string
                      format: date-time
                      example: '2024-01-10T05:19:37.788-08:00'
                    document_name:
                      description: File Upload Request Document Name
                      type: string
                      example: Drivers License.
                  required:
                    - id
                    - recollection_reason
                    - created_at
                    - document_name
              i9_status:
                type: object
                properties:
                  status:
                    description: The status of the i9 Form
                    type: string
                    enum:
                      - awaiting_employee
                      - awaiting_employer
                      - pending
                      - complete
                      - opted_out
                      - awaiting_authorized_representative
                  last_form_update:
                    description: The DateTime the form was last updated at.
                    type: string
                    format: date-time
                    example: '2024-01-10T05:19:37.788-08:00'
                  landed_at:
                    description: The DateTime the applicant filled out the i9 Form.
                    type: string
                    format: date-time
                    example: '2024-01-10T05:19:37.788-08:00'
                required:
                  - status
                  - last_form_update
                  - landed_at
              addresses:
                type: array
                items:
                  type: object
                  properties:
                    street_name:
                      description: Address street name
                      type: string
                    address_2:
                      description: Address two name
                      type: string
                    city:
                      description: Address city name
                      type: string
                    state:
                      description: Address state name
                      type: string
                    zipcode:
                      description: Address zipcode
                      type: string
                    country:
                      description: Address country
                      type: string
                    latitude:
                      description: Address latitude
                      type: number
                    longitude:
                      description: Address longitude
                      type: number
                  required:
                    - street_name
                    - address_2
                    - city
                    - state
                    - zipcode
                    - country
                    - latitude
                    - longitude
              last_transitioned_at:
                description: >-
                  DateTime the applicant was last transitioned from one stage to
                  another.
                type: string
                format: date-time
                example: '2024-01-10T05:19:37.788-08:00'
                nullable: true
              background_checks:
                type: array
                items:
                  anyOf:
                    - type: object
                      properties:
                        title:
                          description: Title of the background check.
                          type: string
                        status:
                          description: Checkr background check status
                          type: string
                          enum:
                            - clear
                            - consider
                            - negative
                            - non_negative
                            - complete
                            - pending
                            - suspended
                            - dispute
                            - canceled
                        updated_at:
                          description: Last updated_at for the background check.
                          type: string
                          format: date-time
                        candidate_id:
                          description: >-
                            The candidate ID of the applicant from the
                            background check provider.
                          type: string
                        report_id:
                          description: >-
                            The report ID of the background check from the
                            background check provider.
                          type: string
                        vendor:
                          type: string
                          enum:
                            - checkr
                      required:
                        - status
                        - title
                        - updated_at
                        - candidate_id
                        - report_id
                        - vendor
                    - type: object
                      properties:
                        title:
                          description: Title of the background check.
                          type: string
                        applicant_id:
                          description: >-
                            The applicant ID of the applicant from the
                            background check provider.
                          type: string
                        updated_at:
                          description: Last updated_at for the background check.
                          type: string
                          format: date-time
                        status:
                          description: Onfido background check status
                          type: string
                          enum:
                            - no bgc
                            - pending
                            - consented
                            - not consented
                            - clear
                            - consider
                            - withdrawn
                            - paused
                            - reopened
                        check_id:
                          description: >-
                            The report ID of the background check from the
                            background check provider.
                          type: string
                        vendor:
                          type: string
                          enum:
                            - onfido
                      required:
                        - status
                        - title
                        - updated_at
                        - applicant_id
                        - check_id
                        - vendor
              document_signatures:
                type: array
                items:
                  anyOf:
                    - type: object
                      properties:
                        signature_id:
                          description: Document Signing ID
                          type: string
                          example: 91990715d51488bdd1e184b83828db8a
                        status:
                          description: Document Signing Status
                          type: string
                          enum:
                            - unopened
                            - opened
                            - signed
                            - admin_reviewed
                        vendor:
                          description: Document Signing Vendor
                          type: string
                          enum:
                            - hellosign
                            - docusign
                        file_url:
                          description: The URL of the signed document
                          type: string
                          format: uri
                          nullable: true
              partner_data:
                type: array
                items:
                  type: object
              can_receive_sms:
                type: boolean
              phone_platform:
                type: string
                enum:
                  - sms
                  - whats_app
              work_availability:
                type: string
                enum:
                  - sunday_morning
                  - sunday_afternoon
                  - sunday_evening
                  - monday_morning
                  - monday_afternoon
                  - monday_evening
                  - tuesday_morning
                  - tuesday_afternoon
                  - tuesday_evening
                  - wednesday_morning
                  - wednesday_afternoon
                  - wednesday_evening
                  - thursday_morning
                  - thursday_afternoon
                  - thursday_evening
                  - friday_morning
                  - friday_afternoon
                  - friday_evening
                  - saturday_morning
                  - saturday_afternoon
                  - saturday_evening
              date_of_birth:
                type: string
                format: date
              team_or_solo:
                type: string
                enum:
                  - team
                  - solo
              funnel:
                type: object
                properties:
                  title:
                    description: Name of the funnel the applicant is currently in.
                    type: string
                  custom_id:
                    description: A custom ID for the funnel
                    type: string
                  id:
                    description: The ID for the funnel
                    type: string
                required:
                  - title
                  - custom_id
                  - id
              stage:
                type: object
                properties:
                  title:
                    description: Name of the stage the applicant is currently in.
                    type: string
                  id:
                    description: The ID for the stage
                    type: string
                  parent_id:
                    description: The stage parent ID for the funnel
                    type: string
                    nullable: true
                  type:
                    description: The stage type.
                    type: string
                nullable: true
                required:
                  - title
                  - id
                  - parent_id
                  - type
            required:
              - id
              - email
              - name
              - first_name
              - last_name
              - phone_number
              - normalized_phone_number
              - phone_number_country_code
              - data
              - created_at
              - updated_at
              - receive_automated_emails
              - labels
              - is_duplicate
              - file_upload_requests
              - i9_status
              - addresses
              - last_transitioned_at
              - background_checks
              - document_signatures
              - partner_data
              - can_receive_sms
              - phone_platform
              - work_availability
              - date_of_birth
              - team_or_solo
              - funnel
              - stage
        pagination:
          $ref: '#/components/schemas/PaginationWithCursor'
      required:
        - applicants
        - pagination
    Applicant:
      type: object
      properties:
        email:
          description: Applicants Email Address
          type: string
          example: example@applicant.com
        name:
          description: Applicants Full Name
          type: string
          example: Michael Jordan
        first_name:
          description: Applicants First Name
          type: string
          example: Michael
        last_name:
          description: Applicants Last Name
          type: string
          example: Jordan
        phone_number:
          description: Applicants Phone Number
          type: string
          example: 214-609-0494
        normalized_phone_number:
          description: Applicants Phone Number
          type: string
          example: '+12146090494'
        phone_number_country_code:
          description: Applicants Phone Number country code
          type: string
          example: '+1'
        data:
          description: Applicant extra information
          type: object
        created_at:
          description: Date when the Applicant was created
          type: string
          format: date-time
          example: '2024-01-10T05:19:37.788-08:00'
        updated_at:
          description: Date when the Applicant was last updated
          type: string
          format: date-time
          example: '2024-01-10T05:19:37.293-08:00'
          nullable: true
        receive_automated_emails:
          description: Whether the Applciant receives automated emails or not.
          type: boolean
          example: true
        labels:
          type: array
          items:
            type: object
            properties:
              title:
                description: Name of the Label
                type: string
                example: Completed Survey
              completed:
                description: Was the label marked as done.
                type: boolean
                example: true
              completed_at:
                description: DateTime the Label was marked as done.
                type: string
                format: date-time
                example: '2023-09-21T17:00:00.000-07:00'
            required:
              - title
              - completed
              - completed_at
        is_duplicate:
          description: Applicants has been marked as a duplicate.
          type: boolean
          example: false
        file_upload_requests:
          type: array
          items:
            type: object
            properties:
              id:
                description: ID of the file upload request.
                type: number
                example: 1
              recollection_reason:
                description: Reason it is being recollected.
                type: string
                enum:
                  - blurry
                  - corrupt
                  - incorrect
                  - expired
                  - custom
              created_at:
                description: Date when the File Upload Request was created
                type: string
                format: date-time
                example: '2024-01-10T05:19:37.788-08:00'
              document_name:
                description: File Upload Request Document Name
                type: string
                example: Drivers License.
            required:
              - id
              - recollection_reason
              - created_at
              - document_name
        portal_url:
          type: string
          format: uri
        secure_data:
          description: >-
            This contains a key/value pair of any data deemed secure.  An
            example would be SSN.
          type: object
          properties:
            disability:
              description: Predefined secure key
              type: string
              nullable: true
            ethnicity:
              description: Predefined secure key
              type: string
              nullable: true
            gender:
              description: Predefined secure key
              type: string
              nullable: true
            sexual_orientation:
              description: Predefined secure key
              type: string
              nullable: true
            transgender_identity:
              description: Predefined secure key
              type: string
              nullable: true
            veteran_us:
              description: Predefined secure key
              type: string
              nullable: true
            citizenship:
              description: Predefined secure key
              type: string
              nullable: true
            can_work_in_us:
              description: Predefined secure key
              type: boolean
              nullable: true
            ssn:
              description: Predefined secure key
              type: string
              nullable: true
            national_identification_number:
              description: Predefined secure key
              type: string
              nullable: true
            tax_id:
              description: Predefined secure key
              type: string
              nullable: true
            income_salary:
              description: Predefined secure key
              type: string
              nullable: true
            income_income_tax_dollar_amount:
              description: Predefined secure key
              type: string
              nullable: true
            income_ss_tax:
              description: Predefined secure key
              type: string
              nullable: true
            income_medicare_tax:
              description: Predefined secure key
              type: string
              nullable: true
            income_taxpayer_identification_number:
              description: Predefined secure key
              type: string
              nullable: true
            bank_name:
              description: Predefined secure key
              type: string
              nullable: true
            bank_routing_number:
              description: Predefined secure key
              type: string
              nullable: true
            bank_account_number:
              description: Predefined secure key
              type: string
              nullable: true
            iban:
              description: Predefined secure key
              type: string
              nullable: true
            bic:
              description: Predefined secure key
              type: string
              nullable: true
            vehicle_make:
              description: Predefined secure key
              type: string
              nullable: true
            vehicle_model:
              description: Predefined secure key
              type: string
              nullable: true
            vehicle_year:
              description: Predefined secure key
              type: number
              nullable: true
            vehicle_registration_plate_number:
              description: Predefined secure key
              type: string
              nullable: true
            vehicle_vin_number:
              description: Predefined secure key
              type: string
              nullable: true
            driver_license_number:
              description: Predefined secure key
              type: string
              nullable: true
            driver_license_expiration_date:
              description: Predefined secure key
              type: string
              nullable: true
            driver_license_state:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_type:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_benefactor_first_name:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_benefactor_middle_name:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_benefactor_last_name:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_member_id:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_company_group_id:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_company_of_issue:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_country_of_issue:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_city_of_issue:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_issue_date:
              description: Predefined secure key
              type: string
              nullable: true
            insurance_expiration_date:
              description: Predefined secure key
              type: string
              nullable: true
            passport_number:
              description: Predefined secure key
              type: string
              nullable: true
            passport_country_of_issue:
              description: Predefined secure key
              type: string
              nullable: true
            passport_city_of_issue:
              description: Predefined secure key
              type: string
              nullable: true
            passport_issue_date:
              description: Predefined secure key
              type: string
              nullable: true
            passport_expiration_date:
              description: Predefined secure key
              type: string
              nullable: true
        lessonly:
          type: object
          properties:
            lesson_results:
              type: array
              items:
                type: object
                properties:
                  lesson_url:
                    description: The URL to visit the Lessonly lesson.
                    type: string
                    format: uri
                  score_percent:
                    description: The score of the Lessonly lesson.
                    type: number
                  report_card_url:
                    description: The URL to Lessonly report card.
                    type: string
                    format: uri
                  completed_at:
                    description: The date-time the lesson was completed.
                    type: string
                    format: date-time
                  lesson_name:
                    description: The Lessonly lesson name.
                    type: string
                required:
                  - lesson_url
                  - score_percent
                  - report_card_url
                  - completed_at
                  - lesson_name
            path_results:
              type: array
              items:
                type: object
                properties:
                  path_url:
                    description: The URL to the Path.
                    type: string
                    format: uri
                  goal:
                    description: Path goal.
                    type: number
                  progress:
                    description: Path progress.
                    type: number
                  path_name:
                    description: The Path name.
                    type: string
                required:
                  - path_url
                  - goal
                  - progress
                  - path_name
          required:
            - lesson_results
            - path_results
        video_urls:
          type: array
          items:
            description: The URL of the video.
            type: string
            format: uri
        assigned_user:
          type: object
          properties:
            id:
              description: The assigned user's id
              type: string
            email:
              description: The assigned user's email address
              type: string
            name:
              description: The assigned user's name
              type: string
        i9:
          type: object
          properties:
            last_name:
              description: i9 form collected last name.
              type: string
            first_name:
              description: i9 form collected first name.
              type: string
            middle_initial:
              description: i9 form collected middle name.
              type: string
            other_last_names:
              description: i9 form collected other last name.
              type: string
            address:
              description: i9 form collected address.
              type: string
            apartment_number:
              description: i9 form collected apartment number.
              type: string
            city:
              description: i9 form collected city.
              type: string
            state:
              description: i9 form collected state.
              type: string
            zipcode:
              description: i9 form collected zipcode.
              type: number
            date_of_birth:
              description: i9 form collected date of birth.
              type: string
            ssn:
              description: i9 form collected Social Security Number.
              type: string
            email:
              description: i9 form collected email.
              type: string
            telephone:
              description: i9 form collected telephone.
              type: string
            citizenship_status:
              description: i9 form collected citizenship status.
              type: string
            signature_date:
              description: i9 form signature date.
              type: string
            preparer_used:
              description: Indicating if the i9 form was prepared by someone else.
              type: string
              enum:
                - t
                - f
            employer_signature_date:
              description: Employer signed date in YYYY-MM-DD formate.
              type: string
            preparer_signature_date:
              description: Preparer signed date in YYYY-MM-DD formate.
              type: string
            preparer_last_name:
              description: Prepares first name.
              type: string
              nullable: true
            preparer_first_name:
              description: Prepares last name.
              type: string
              nullable: true
            preparer_address:
              description: Prepares address.
              type: string
              nullable: true
            preparer_city:
              description: Prepares city.
              type: string
              nullable: true
            preparer_state:
              description: Prepares state.
              type: string
              nullable: true
            preparer_zipcode:
              description: Prepares zipcode.
              type: string
              nullable: true
          required:
            - last_name
            - first_name
            - middle_initial
            - other_last_names
            - address
            - apartment_number
            - city
            - state
            - zipcode
            - date_of_birth
            - ssn
            - email
            - telephone
            - citizenship_status
            - signature_date
            - preparer_used
            - employer_signature_date
            - preparer_signature_date
            - preparer_last_name
            - preparer_first_name
            - preparer_address
            - preparer_city
            - preparer_state
            - preparer_zipcode
        i9_status:
          type: object
          properties:
            status:
              description: The status of the i9 Form
              type: string
              enum:
                - awaiting_employee
                - awaiting_employer
                - pending
                - complete
                - opted_out
                - awaiting_authorized_representative
            last_form_update:
              description: The DateTime the form was last updated at.
              type: string
              format: date-time
              example: '2024-01-10T05:19:37.788-08:00'
            landed_at:
              description: The DateTime the applicant filled out the i9 Form.
              type: string
              format: date-time
              example: '2024-01-10T05:19:37.788-08:00'
        i9_pdf:
          description: The URL to visit i9 PDF Form.
          type: string
          nullable: true
        everify:
          type: object
          properties:
            case_number:
              description: E-Verify case number.
              type: string
            case_status:
              description: E-Verify case status.
              type: string
              enum:
                - CLOSE_CASE_AND_RESUBMIT
                - CLOSED
                - DRAFT
                - EMPLOYMENT_AUTHORIZED
                - FINAL_NONCONFIRMATION
                - MANUAL_REVIEW
                - PENDING_REFERRAL
                - PHOTO_MATCH
                - QUEUED
                - REFERRED
                - SCAN_AND_UPLOAD
                - UNCONFIRMED_DATA
            case_eligibility_statement:
              description: E-Verify case eligbility statement.
              type: string
              nullable: true
              enum:
                - EMPLOYMENT_AUTHORIZED
                - NO_ACTION_FNC
                - NO_SHOW
                - NOT_AUTHORIZED_EMPLOYMENT
                - RESUBMIT_CASE
            created_at:
              description: E-Verify case created_at.
              type: string
              format: date-time
            updated_at:
              description: E-Verify case updated_at.
              type: string
              format: date-time
          required:
            - case_number
            - case_status
            - case_eligibility_statement
            - created_at
            - updated_at
        addresses:
          type: array
          items:
            type: object
            properties:
              street_name:
                description: Address street name
                type: string
              address_2:
                description: Address two name
                type: string
              city:
                description: Address city name
                type: string
              state:
                description: Address state name
                type: string
              zipcode:
                description: Address zipcode
                type: string
              country:
                description: Address country
                type: string
              latitude:
                description: Address latitude
                type: number
              longitude:
                description: Address longitude
                type: number
            required:
              - street_name
              - address_2
              - city
              - state
              - zipcode
              - country
              - latitude
              - longitude
        id:
          description: >-
            ID of the applicant used when making calls on behalf of the
            applicant.
          type: string
          example: 5c0f5463-0103-46ce-abd3-749f5551d00e
        last_transitioned_at:
          description: >-
            DateTime the applicant was last transitioned from one stage to
            another.
          type: string
          format: date-time
          example: '2024-01-10T05:19:37.788-08:00'
          nullable: true
        background_checks:
          type: array
          items:
            anyOf:
              - type: object
                properties:
                  title:
                    description: Title of the background check.
                    type: string
                  status:
                    description: Checkr background check status
                    type: string
                    enum:
                      - clear
                      - consider
                      - negative
                      - non_negative
                      - complete
                      - pending
                      - suspended
                      - dispute
                      - canceled
                  updated_at:
                    description: Last updated_at for the background check.
                    type: string
                    format: date-time
                  candidate_id:
                    description: >-
                      The candidate ID of the applicant from the background
                      check provider.
                    type: string
                  report_id:
                    description: >-
                      The report ID of the background check from the background
                      check provider.
                    type: string
                  vendor:
                    type: string
                    enum:
                      - checkr
                required:
                  - status
                  - title
                  - updated_at
                  - candidate_id
                  - report_id
                  - vendor
              - type: object
                properties:
                  title:
                    description: Title of the background check.
                    type: string
                  applicant_id:
                    description: >-
                      The applicant ID of the applicant from the background
                      check provider.
                    type: string
                  updated_at:
                    description: Last updated_at for the background check.
                    type: string
                    format: date-time
                  status:
                    description: Onfido background check status
                    type: string
                    enum:
                      - no bgc
                      - pending
                      - consented
                      - not consented
                      - clear
                      - consider
                      - withdrawn
                      - paused
                      - reopened
                  check_id:
                    description: >-
                      The report ID of the background check from the background
                      check provider.
                    type: string
                  vendor:
                    type: string
                    enum:
                      - onfido
                required:
                  - status
                  - title
                  - updated_at
                  - applicant_id
                  - check_id
                  - vendor
        document_signatures:
          type: array
          items:
            anyOf:
              - type: object
                properties:
                  signature_id:
                    description: Document Signing ID
                    type: string
                    example: 91990715d51488bdd1e184b83828db8a
                  status:
                    description: Document Signing Status
                    type: string
                    enum:
                      - unopened
                      - opened
                      - signed
                      - admin_reviewed
                  vendor:
                    description: Document Signing Vendor
                    type: string
                    enum:
                      - hellosign
                      - docusign
                  file_url:
                    description: The URL of the signed document
                    type: string
                    format: uri
                    nullable: true
        partner_data:
          type: array
          items:
            type: object
        partner_option_data:
          type: array
          items:
            type: object
        can_receive_sms:
          type: boolean
        phone_platform:
          type: string
          enum:
            - sms
            - whats_app
        work_availability:
          type: string
          enum:
            - sunday_morning
            - sunday_afternoon
            - sunday_evening
            - monday_morning
            - monday_afternoon
            - monday_evening
            - tuesday_morning
            - tuesday_afternoon
            - tuesday_evening
            - wednesday_morning
            - wednesday_afternoon
            - wednesday_evening
            - thursday_morning
            - thursday_afternoon
            - thursday_evening
            - friday_morning
            - friday_afternoon
            - friday_evening
            - saturday_morning
            - saturday_afternoon
            - saturday_evening
        date_of_birth:
          type: string
          format: date
        team_or_solo:
          type: string
          enum:
            - team
            - solo
        ssn:
          description: Predefined secure key at the root
          type: string
          nullable: true
        funnel:
          type: object
          properties:
            title:
              description: Name of the funnel the applicant is currently in.
              type: string
            custom_id:
              description: A custom ID for the funnel
              type: string
            id:
              description: The ID for the funnel
              type: string
            location:
              description: Job Location for the given Opening.
              type: object
              properties:
                name:
                  description: ''
                  type: string
                id:
                  description: ''
                  type: string
                latitude:
                  description: ''
                  type: number
                longitude:
                  description: ''
                  type: number
                location_group:
                  description: ''
                  type: object
                  properties:
                    name:
                      description: ''
                      type: string
                    id:
                      description: ''
                      type: string
                  required:
                    - name
                    - id
              required:
                - name
                - id
                - latitude
                - longitude
                - location_group
            position:
              description: Job Position
              type: object
              properties:
                name:
                  description: ''
                  type: string
                id:
                  description: ''
                  type: string
              required:
                - name
                - id
          required:
            - title
            - custom_id
            - id
        stage:
          type: object
          properties:
            title:
              description: Name of the stage the applicant is currently in.
              type: string
            id:
              description: The ID for the stage
              type: string
            parent_id:
              description: The stage parent ID for the funnel
              type: string
              nullable: true
            type:
              description: The stage type.
              type: string
          nullable: true
          required:
            - title
            - id
            - parent_id
            - type
        w4_federal_form:
          type: object
          properties:
            form_url:
              description: W4 Download URL
              type: string
              format: uri
            status:
              description: W4 Status
              type: string
              enum:
                - awaiting_employee
                - awaiting_employer
                - pending
                - complete
                - opted_out
                - awaiting_authorized_representative
            external_id:
              description: UUID for W4 external ID
              type: string
            show_applicant_redo_buttons:
              description: ''
              type: boolean
            applicant_external_id:
              description: Applicant external ID
              type: string
            contents:
              description: ''
              type: object
              properties:
                first_name:
                  description: First name
                  type: string
                last_name:
                  description: Last name
                  type: string
                ssn:
                  description: Social Security Number
                  type: string
              required:
                - first_name
                - last_name
                - ssn
          required:
            - form_url
            - status
            - external_id
            - show_applicant_redo_buttons
            - applicant_external_id
            - contents
        w4_state_form:
          type: object
          properties:
            form_state:
              description: W4 State
              type: string
            form_url:
              description: W4 Download URL
              type: string
              format: uri
            status:
              description: W4 Status
              type: string
              enum:
                - awaiting_employee
                - awaiting_employer
                - pending
                - complete
                - opted_out
                - awaiting_authorized_representative
            external_id:
              description: UUID for W4 external ID
              type: string
            show_applicant_redo_buttons:
              description: ''
              type: boolean
            applicant_external_id:
              description: Applicant external ID
              type: string
            employer_enabled:
              type: boolean
              nullable: true
            data:
              type: object
          required:
            - form_state
            - form_url
            - status
            - external_id
            - show_applicant_redo_buttons
            - applicant_external_id
            - employer_enabled
            - data
        score_cards_results:
          type: array
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
        rejection_reason:
          description: Manually set reason for rejection.
          type: string
        disability:
          description: Predefined secure key at the root
          type: string
          nullable: true
        ethnicity:
          description: Predefined secure key at the root
          type: string
          nullable: true
        gender:
          description: Predefined secure key at the root
          type: string
          nullable: true
        sexual_orientation:
          description: Predefined secure key at the root
          type: string
          nullable: true
        transgender_identity:
          description: Predefined secure key at the root
          type: string
          nullable: true
        veteran_us:
          description: Predefined secure key at the root
          type: string
          nullable: true
        citizenship:
          description: Predefined secure key at the root
          type: string
          nullable: true
        can_work_in_us:
          description: Predefined secure key at the root
          type: boolean
          nullable: true
        national_identification_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        tax_id:
          description: Predefined secure key at the root
          type: string
          nullable: true
        income_salary:
          description: Predefined secure key at the root
          type: string
          nullable: true
        income_income_tax_dollar_amount:
          description: Predefined secure key at the root
          type: string
          nullable: true
        income_ss_tax:
          description: Predefined secure key at the root
          type: string
          nullable: true
        income_medicare_tax:
          description: Predefined secure key at the root
          type: string
          nullable: true
        income_taxpayer_identification_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        bank_name:
          description: Predefined secure key at the root
          type: string
          nullable: true
        bank_routing_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        bank_account_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        iban:
          description: Predefined secure key at the root
          type: string
          nullable: true
        bic:
          description: Predefined secure key at the root
          type: string
          nullable: true
        vehicle_make:
          description: Predefined secure key at the root
          type: string
          nullable: true
        vehicle_model:
          description: Predefined secure key at the root
          type: string
          nullable: true
        vehicle_year:
          description: Predefined secure key at the root
          type: number
          nullable: true
        vehicle_registration_plate_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        vehicle_vin_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        driver_license_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        driver_license_expiration_date:
          description: Predefined secure key at the root
          type: string
          nullable: true
        driver_license_state:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_type:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_benefactor_first_name:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_benefactor_middle_name:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_benefactor_last_name:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_member_id:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_company_group_id:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_company_of_issue:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_country_of_issue:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_city_of_issue:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_issue_date:
          description: Predefined secure key at the root
          type: string
          nullable: true
        insurance_expiration_date:
          description: Predefined secure key at the root
          type: string
          nullable: true
        passport_number:
          description: Predefined secure key at the root
          type: string
          nullable: true
        passport_country_of_issue:
          description: Predefined secure key at the root
          type: string
          nullable: true
        passport_city_of_issue:
          description: Predefined secure key at the root
          type: string
          nullable: true
        passport_issue_date:
          description: Predefined secure key at the root
          type: string
          nullable: true
        passport_expiration_date:
          description: Predefined secure key at the root
          type: string
          nullable: true
      required:
        - email
        - name
        - first_name
        - last_name
        - phone_number
        - normalized_phone_number
        - phone_number_country_code
        - data
        - created_at
        - updated_at
        - receive_automated_emails
        - labels
        - is_duplicate
        - file_upload_requests
        - secure_data
        - i9_status
        - addresses
        - id
        - last_transitioned_at
        - background_checks
        - document_signatures
        - partner_data
        - partner_option_data
        - can_receive_sms
        - phone_platform
        - funnel
        - stage
    CreateApplicantRequest:
      type: object
      properties:
        name:
          description: Applicants full name.
          type: string
        email:
          description: Applicants email.
          type: string
        phone_number:
          description: Applicants complete phone number.
          type: string
      required:
        - name
        - email
        - phone_number
    CreateUpdateApplicantNote:
      type: object
      properties:
        content:
          description: ''
          type: string
        user_id:
          description: User UUID who will be assigned as the creating user.
          type: string
          nullable: true
      required:
        - content
    ApplicantNote:
      type: object
      properties:
        id:
          description: ''
          type: string
        content:
          description: ''
          type: string
        created_at:
          description: ''
          type: string
          format: date-time
        updated_at:
          description: ''
          type: string
          format: date-time
        last_updated_by:
          type: object
          properties:
            name:
              description: Applicants name
              type: string
            email:
              description: Applicants email
              type: string
            id:
              description: Applicants id
              type: string
          nullable: true
          required:
            - name
            - email
            - id
        user:
          type: object
          properties:
            name:
              description: Applicants name
              type: string
            email:
              description: Applicants email
              type: string
            id:
              description: Applicants id
              type: string
          nullable: true
          required:
            - name
            - email
            - id
      required:
        - id
        - content
        - created_at
        - updated_at
        - last_updated_by
        - user
    ApplicantNotesResponse:
      type: object
      properties:
        notes:
          type: array
          items:
            $ref: '#/components/schemas/ApplicantNote'
      required:
        - notes
    ApplicantSecureDocumentsResponse:
      type: object
      properties:
        secure_documents:
          type: array
          items:
            type: object
            properties:
              name:
                description: Name of the secure document.
                type: string
              friendly_name:
                description: Friendly name of the secure document.
                type: string
              filename:
                description: Document filename of file.
                type: string
              size:
                description: Size of secure document in bytes.
                type: number
              approved:
                description: If the document is approved or not.
                type: boolean
              id:
                description: ID of the secure document.
                type: string
              public_url:
                description: The URL to download the secure document.
                type: string
                format: uri
              stage:
                type: object
                properties:
                  title:
                    description: Title of the stage.
                    type: string
                  id:
                    description: ID of the stage.
                    type: string
                  form_title:
                    description: Form Title of the stage.
                    type: string
                    nullable: true
                  form_description:
                    description: Form Description of the stage.
                    type: string
                    nullable: true
                required:
                  - id
                  - title
              file_upload_requests:
                type: array
                items:
                  type: object
                  properties:
                    recollection_reason:
                      description: Reason the upload is being recollected.
                      type: string
                      enum:
                        - blurry
                        - corrupt
                        - incorrect
                        - expired
                        - custom
                    created_at:
                      description: DateTime the re-collection request was triggered.
                      type: string
              created_at:
                description: DateTime the file was created.
                type: string
              approved_at:
                description: DateTime the file was approved.
                type: string
                nullable: true
            required:
              - name
              - friendly_name
              - filename
              - size
              - approved
              - id
              - public_url
              - stage
              - created_at
              - approved_at
      required:
        - secure_documents
    ApplicantSecureDocumentUploadResponse:
      type: object
      properties:
        url:
          description: The URL to upload the file to.
          type: string
          format: uri
        host:
          description: The HOST of the URL.
          type: string
        min_size:
          description: Minimum file upload size.
          type: number
        max_size:
          description: Maximum file upload size.
          type: number
        only_images:
          description: TRUE if only for uploading images.
          type: boolean
        type:
          description: HTTP verb to upload file.
          type: string
        form_data:
          type: object
          properties:
            key:
              description: Path of the filename to be uploaded.
              type: string
            success_action_status:
              description: HTTP code if upload is successful.
              type: string
            acl:
              description: Network Access Control List
              type: string
            x-amz-server-side-encryption-customer-algorithm:
              description: ''
              type: string
            x-amz-server-side-encryption-customer-key:
              description: ''
              type: string
            x-amz-server-side-encryption-customer-key-MD5:
              description: ''
              type: string
            policy:
              description: ''
              type: string
            x-amz-credential:
              description: ''
              type: string
            x-amz-algorithm:
              description: ''
              type: string
            x-amz-date:
              description: ''
              type: string
            x-amz-signature:
              description: ''
              type: string
          required:
            - key
            - success_action_status
            - acl
            - policy
            - x-amz-server-side-encryption-customer-algorithm
            - x-amz-server-side-encryption-customer-key
            - x-amz-server-side-encryption-customer-key-MD5
            - x-amz-credential
            - x-amz-algorithm
            - x-amz-date
            - x-amz-signature
      required:
        - url
        - host
        - form_data
        - min_size
        - max_size
        - only_images
    ApplicantSecureDocumentLinkUploadResponse:
      type: object
      properties:
        uploaded:
          type: boolean
      required:
        - uploaded
    ApplicantTransitionHistoryResponse:
      type: object
      properties:
        transitions:
          type: array
          items:
            type: object
            properties:
              stage_id:
                description: The Stage ID
                type: string
              stage_title:
                description: The Stage Title
                type: string
              created_at:
                description: Date the transition record was created.
                type: string
                format: date-time
              parent_stage_id:
                description: Parent Stage ID, if it exists.
                type: string
                nullable: true
              parent_stage_title:
                description: Parent Stage Title, if it exists.
                type: string
                nullable: true
              sub_stage_id:
                description: Sub Stage ID, if it exists.
                type: string
                nullable: true
              sub_stage_title:
                description: Sub Stage Title, if it exists.
                type: string
                nullable: true
              transitioned_by:
                description: Sub Stage Title, if it exists.
                type: string
                nullable: true
              user:
                description: User who performed the transition.
                type: string
                nullable: true
              funnel_id:
                description: The Funnel ID
                type: string
                nullable: true
            required:
              - stage_id
              - stage_title
              - created_at
              - parent_stage_id
              - parent_stage_title
              - sub_stage_id
              - sub_stage_title
              - transitioned_by
              - user
        pagination:
          $ref: '#/components/schemas/PaginationWithCursor'
      required:
        - transitions
        - pagination
    ApplicantBookeSlotResponse:
      type: object
      properties:
        booked_slots:
          type: array
          items:
            type: object
            properties:
              start_time:
                description: Interview start time.
                type: string
              end_time:
                description: Interview end time.
                type: string
              booked_time:
                description: Interview booked time.
                type: string
              location:
                description: Location of interview.
                type: string
              recruiter:
                description: Name of the recruiter
                type: string
              instructions:
                description: Instructions for the applicant.
                type: string
              showed_up:
                description: ''
                type: string
                nullable: true
              stage_title:
                description: Stage title.
                type: string
              id:
                description: Booked slot ID.
                type: string
            required:
              - start_time
              - end_time
              - booked_time
              - location
              - recruiter
              - instructions
              - showed_up
              - stage_title
              - id
      required:
        - booked_slots
    IndexExportResponse:
      type: object
      properties:
        exports:
          type: array
          items:
            $ref: '#/components/schemas/CreateShowExportResponse'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - exports
        - pagination
    IndexTimestampedExportResponse:
      type: object
      properties:
        timestamped_exports:
          type: array
          items:
            $ref: '#/components/schemas/CreateShowTimestampedExportResponse'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - timestamped_exports
        - pagination
    IndexTimestampedExportTemplateResponse:
      type: object
      properties:
        templates:
          type: array
          items:
            type: object
            properties:
              title:
                description: Timestamped Export Template Title
                type: string
              id:
                description: Timestamped Export Template ID
                type: string
              data_keys:
                type: array
                items:
                  type: string
              upper_bound:
                description: ''
                type: string
                format: date-time
              lower_bound:
                description: ''
                type: string
                format: date-time
              busy:
                type: boolean
              type:
                type: string
              number_of_days:
                type: string
                nullable: true
              funnel_ids:
                type: array
                items: {}
            required:
              - id
              - title
              - data_keys
              - upper_bound
              - lower_bound
              - busy
              - type
              - number_of_days
              - funnel_ids
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - templates
        - pagination
    IndexExportTemplatesResponse:
      type: object
      properties:
        templates:
          type: array
          items:
            type: object
            properties:
              title:
                description: Title of the export template.
                type: string
              id:
                description: ID of the export template.
                type: string
              fields:
                type: array
                items:
                  description: Name of the fields in the export
                  type: string
              funnel_ids:
                type: array
                items:
                  description: Funnel external IDs
                  type: string
            required:
              - id
              - title
              - fields
              - funnel_ids
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - templates
        - pagination
    CreateShowExportResponse:
      type: object
      properties:
        id:
          description: Exports ID
          type: string
        created_at:
          description: Created date for export
          type: string
          format: date-time
        updated_at:
          description: Updated date for export
          type: string
          format: date-time
        status:
          description: Updated date for export
          type: string
        file_url:
          description: URL to download the export.
          type: string
          nullable: true
        template:
          type: object
          properties:
            title:
              description: Title of the template used.
              type: string
            id:
              description: Template ID
              type: string
          required:
            - id
            - title
      required:
        - id
        - created_at
        - updated_at
        - status
        - file_url
        - template
    CreateShowTimestampedExportResponse:
      type: object
      properties:
        id:
          description: Exports ID
          type: string
        created_at:
          description: Created date for export
          type: string
          format: date-time
        updated_at:
          description: Updated date for export
          type: string
          format: date-time
        state:
          description: Updated date for export
          type: string
        file_url:
          description: URL to download the export.
          type: string
          nullable: true
        template:
          type: object
          properties:
            title:
              description: Title of the template used.
              type: string
            id:
              description: Template ID
              type: string
          required:
            - id
            - title
      required:
        - id
        - created_at
        - updated_at
        - state
        - file_url
        - template
    MultipleApplicantsTransitionHistoryResponse:
      type: array
      items:
        type: object
        properties:
          applicant_id:
            description: Applicant UUID
            type: string
          transitions:
            type: array
            items:
              type: object
              properties:
                stage_id:
                  description: The Stage ID
                  type: string
                stage_title:
                  description: The Stage Title
                  type: string
                created_at:
                  description: Date the transition record was created.
                  type: string
                  format: date-time
                parent_stage_id:
                  description: Parent Stage ID, if it exists.
                  type: string
                  nullable: true
                parent_stage_title:
                  description: Parent Stage Title, if it exists.
                  type: string
                  nullable: true
                sub_stage_id:
                  description: Sub Stage ID, if it exists.
                  type: string
                  nullable: true
                sub_stage_title:
                  description: Sub Stage Title, if it exists.
                  type: string
                  nullable: true
                funnel_id:
                  description: The Funnel ID
                  type: string
                  nullable: true
              required:
                - stage_id
                - stage_title
                - created_at
                - parent_stage_id
                - parent_stage_title
                - sub_stage_id
                - sub_stage_title
        required:
          - applicant_id
          - transitions
    MultipleApplicantsBookedSlotResponse:
      type: array
      items:
        type: object
        properties:
          applicant_id:
            description: Applicant UUID
            type: string
          booked_slots:
            type: array
            items:
              type: object
              properties:
                start_time:
                  description: Interview start time.
                  type: string
                end_time:
                  description: Interview end time.
                  type: string
                booked_time:
                  description: Interview booked time.
                  type: string
                location:
                  description: Location of interview.
                  type: string
                recruiter:
                  description: Name of the recruiter
                  type: string
                instructions:
                  description: Instructions for the applicant.
                  type: string
                showed_up:
                  description: ''
                  type: string
                  nullable: true
                stage_title:
                  description: Stage title.
                  type: string
                id:
                  description: Booked slot ID.
                  type: string
              required:
                - start_time
                - end_time
                - booked_time
                - location
                - recruiter
                - instructions
                - showed_up
                - stage_title
                - id
        required:
          - applicant_id
          - booked_slots
    AvailableSlot:
      type: object
      properties:
        id:
          description: Unique identifier of the available slot
          type: string
        start_time:
          description: Start time of the available slot
          type: string
          format: datetime
        end_time:
          description: End time of the available slot
          type: string
          format: datetime
        location:
          description: Location of the available slot
          type: string
          nullable: true
        recruiter:
          description: Name of recruiter for the available slot
          type: string
        max_attendees:
          description: Maximum number of attendees for the slot
          type: integer
        booked_slots_count:
          description: Count of booked slots for the availble slot
          type: integer
      required:
        - id
        - start_time
        - end_time
        - booked_slots_count
    BookedSlot:
      type: object
      properties:
        id:
          description: Unique identifier for the booked slot
          type: string
        location:
          description: Location of the booked slot
          type: string
        recruiter:
          description: Name of user associated with the booked slot
          type: string
        start_time:
          description: The time the booked slot starts
          type: string
          format: datetime
        end_time:
          description: The time the booked slot ends
          type: string
          format: datetime
        booked_time:
          description: The time the booked slot was booked
          type: string
          format: datetime
        instructions:
          description: Instructions for the booked slot
          type: string
          nullable: true
        showed_up:
          description: Indicator for whether the applicant showed up
          type: boolean
          nullable: true
        stage_title:
          description: Title of the stage associated with the booked slot
          type: string
      required:
        - id
        - start_time
        - end_time
        - booked_time
    SessionBookedSlot:
      type: object
      properties:
        id:
          description: The unique identifier of the booked slot
          type: string
        applicant_showed:
          description: Indicator for whether the applicant attended
          type: boolean
          nullable: true
        applicant_is_still_on_stage:
          description: >-
            Indicator for whether the applicant is still on the stage associated
            to the slot
          type: boolean
        complete:
          description: Indicator of whether the slot has been completed
          type: boolean
        stage_title:
          description: Title of the stage associated with the booked slot
          type: string
        stage_id:
          description: Unique identifier of the stage associated to the booked slot
          type: string
        stage_external_id:
          description: >-
            Unique identifier of the stage associated to the booked slot
            (deprecated; refer to "stage_id")
          type: string
        funnel_title:
          description: Title of the opening associated to the slot
          type: string
          nullable: true
        available_slot_location:
          description: The location of the booked slot
          type: string
          nullable: true
        applicant:
          description: Applicant associated to the booked slot
          $ref: '#/components/schemas/BookedSlotApplicant'
      required:
        - id
        - applicant_is_still_on_stage
        - complete
        - stage_title
        - stage_id
        - stage_external_id
        - applicant
    BookedSlotApplicant:
      type: object
      properties:
        id:
          description: The unique identifier of the applicant
          type: string
        name:
          description: The name of the applicant
          type: string
        email:
          description: The email of the applicant
          type: string
        key:
          description: Unique key for the applicant
          type: string
        phone_number:
          description: Phone number of the applicant
          type: string
        stage_title:
          description: Title of the stage associated with the applicant
          type: string
        external_id:
          description: The unique identifier of the applicant (deprecated; refer to "id")
          type: string
        can_show:
          description: Deprecated
          type: boolean
        data:
          description: Data collected about the applicant
          type: object
        structured_data:
          description: Structured data collected about the applicant
          type: object
      required:
        - id
        - name
        - email
        - key
        - phone_number
        - external_id
        - can_show
        - data
        - structured_data
    CustomerAttribute:
      type: object
      properties:
        value:
          description: Value of the attribute
          type: string
        type:
          description: The key of the attribute
          type: string
      required:
        - value
        - type
    DataKey:
      type: object
      properties:
        title:
          description: The human-readable title of a DataKey
          type: string
        key:
          description: The DataKey key.
          type: string
        key_type:
          description: The type of data to be stored by the DataKey
          type: string
        hidden:
          description: Indicator for whether DataKey is visible
          type: boolean
        restricted:
          description: Indicator for whether DataKey is privileged
          type: boolean
        data_fields_count:
          description: The number of data_fields attached to applicants.
          type: integer
        options:
          description: List of options for associated data fields
          type: array
          items:
            $ref: '#/components/schemas/DataKeyOption'
          nullable: true
      required:
        - key
        - key_type
        - title
        - hidden
        - restricted
        - data_fields_count
    DataKeyOption:
      type: object
      properties:
        value:
          description: The value persisted for the option
          type: string
        label:
          description: The human-readable value for the option
          type: string
      required:
        - value
    Funnel:
      type: object
      properties:
        title:
          description: The title of the opening
          type: string
        description:
          description: The description of the opening
          type: string
        apply_url:
          description: The URL with which to apply to the opening
          type: string
        id:
          description: Unique identifier for the opening
          type: string
        address:
          description: The address of the opening
          type: string
        time_zone:
          description: The timezone of the opening
          type: string
        requirements:
          description: Description of what is required for the opening
          type: string
        is_private:
          description: Indicator for whether the opening is private
          type: boolean
        active:
          description: Indicator for whether the opening is active
          type: boolean
        custom_id:
          description: Identifier custom to opening for the account
          type: string
          nullable: true
        force_applicant_identity:
          description: Indicator for whether applicant identity is enforced
          type: boolean
          nullable: true
        created_at:
          description: Date when the opening was created
          type: string
        additional_info:
          description: Additional info about the opening
          type: string
          nullable: true
        brand:
          description: The brand the opening is associated with
          type: string
          nullable: true
        opening_pay_rate:
          description: The pay rate for the opening
          $ref: '#/components/schemas/OpeningPayRate'
          nullable: true
        job_hours:
          description: Indicator for whether the opening is full or part time
          type: string
          enum:
            - full_time
            - part_time
          nullable: true
        job_type:
          description: The type of job represented by the opening
          type: string
          enum:
            - permanent
            - temporary
            - contract_freelancer
            - casual
            - finance_plus_accounting
            - operations_leadership
            - all_other_administrative_plus_professional
            - information_technology
            - customer_service_plus_operations
            - local
            - regional
            - trainee
          nullable: true
        job_industry:
          description: Industry the opening is for
          type: string
          enum:
            - accounting
            - agriculture
            - audio_visual
            - automotive
            - banking_and_finance
            - construction
            - consultancy
            - customer_service_and_call_centres
            - dental
            - education_and_training
            - electronics
            - energy_oil_and_gas
            - engineering
            - environmental_and_waste
            - facilities_management
            - food_hospitality
            - hair_beauty_and_cosmetics
            - health_medical_and_related
            - human_resources
            - insurance
            - it_and_internet
            - legal
            - logistics_procurement_distribution_and_supply_chain
            - manufacturing_and_production
            - marketing_advertising_and_pr
            - media_new_media_and_creative
            - military_and_defence
            - mining
            - nonprofit
            - other
            - property_and_real-estate
            - recruitment
            - retail
            - sales
            - scientific_and_pharmaceuticals
            - secretarial_and_administration
            - telecommunications
            - training
            - travel_leisure_and_tourism
            - transportation
            - web_html_info_design
            - writing_editing
          nullable: true
        workflow_id:
          description: Unique identifier with the workflow associated to the opening
          type: string
          nullable: true
        is_hiring_funnel:
          description: Indicator for whether the opening is for hiring
          type: boolean
        is_sourcing_funnel:
          description: Indicator for whether the opening is for sourcing
          type: boolean
        alternative_locales:
          description: List of alternate locales
          type: array
          items:
            description: Locale identifier
            type: string
        customer_attributes:
          description: List of customer attributes for the opening
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
        stages:
          description: List of stages in the opening
          type: array
          items:
            $ref: '#/components/schemas/OpeningStage'
        fields:
          description: List of data fields in the opening
          type: array
          items:
            $ref: '#/components/schemas/OpeningDataField'
        location:
          description: The location of the opening
          $ref: '#/components/schemas/Location'
        owner:
          description: The owner of the opening
          $ref: '#/components/schemas/User'
        position:
          description: The position of the opening
          $ref: '#/components/schemas/Position'
        shift:
          description: The shift of the opening
          $ref: '#/components/schemas/Shift'
          nullable: true
      required:
        - id
        - apply_url
        - address
        - time_zone
        - is_private
        - active
        - created_at
        - is_hiring_funnel
        - is_sourcing_funnel
        - stages
        - location
        - owner
        - position
    OpeningDataField:
      type: object
      properties:
        question:
          description: Text of the question
          type: string
        type:
          description: The type of the input for the question
          type: string
        key:
          description: The key the data is collected under
          type: string
      required:
        - key
        - type
        - question
    HiringGoal:
      type: object
      properties:
        external_id:
          description: Unique identifier of the Hiring Goal
          type: string
        goal:
          description: Number of hires needed for this Hiring Goal
          type: integer
        hire_by:
          description: Date that the Hiring Goal ends
          type: string
        start_date:
          description: Date that the Hiring Goal begins
          type: string
        hires_count:
          description: Number of hires currently associated with the Hiring Goal
          type: integer
        past_due:
          description: Indicates if the hire_by date is in the past
          type: boolean
        remaining_days:
          description: Number of days until this Hiring Goal ends
          type: integer
        status:
          description: Current status of the Hiring Goal
          type: string
          enum:
            - unfilled
            - filled
    Location:
      type: object
      properties:
        name:
          description: The name of the location
          type: string
        id:
          description: Unique identifier for the location
          type: string
        latitude:
          description: The latitude of the location
          type: number
        longitude:
          description: The longitude of the location
          type: number
        customer_attributes:
          description: List of customer attributes for the location
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
        location_group:
          description: Grouping of locations
          $ref: '#/components/schemas/LocationGroup'
      required:
        - id
        - name
        - location_group
    LocationDetail:
      type: object
      properties:
        account_id:
          description: Unique identifier for the account
          type: string
        address:
          description: The address of the location
          type: string
          nullable: true
        country_code:
          description: The country code for the location
          type: string
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
        id:
          description: Unique identifier for the location
          type: string
        language:
          description: The language for the location
          type: string
          enum:
            - id
            - cs
            - de
            - en-US
            - en-GB
            - es
            - fr
            - it
            - ms
            - nl
            - nn-NO
            - pl
            - pt
            - ro
            - fi
            - sv
            - vi
            - tr
            - uk-UA
            - el
            - bg
            - ru
            - he
            - ar
            - hi-in
            - ta-IN
            - kn-IN
            - bn-IN
            - gu-IN
            - ml-IN
            - mr-IN
            - pa-IN
            - te-IN
            - th
            - ko
            - ja
            - zh-CN
            - zh-TW
        location_group:
          description: The location group associated to the location
          type: object
          properties:
            id:
              description: Unique identifier for the location group
              type: string
            name:
              description: Name of the location group
              type: string
            owner:
              description: Name of the location group owner
              type: string
          required:
            - id
            - name
            - owner
        name:
          description: The name of the location
          type: string
        owner:
          description: Name of the location owner
          type: string
        openings_count:
          description: The number of openings the location is associated to
          type: integer
          nullable: true
        openings:
          description: List of openings the location is tied to
          type: array
          items:
            type: object
            properties:
              title:
                description: The title of the opening
                type: string
              id:
                description: Unique identifier for the opening
                type: string
        time_zone:
          description: The time zone for the location
          type: string
          enum:
            - Africa/Algiers
            - Africa/Cairo
            - Africa/Casablanca
            - Africa/Harare
            - Africa/Johannesburg
            - Africa/Monrovia
            - Africa/Nairobi
            - America/Argentina/Buenos_Aires
            - America/Bogota
            - America/Caracas
            - America/Chicago
            - America/Chihuahua
            - America/Denver
            - America/Godthab
            - America/Guatemala
            - America/Guyana
            - America/Halifax
            - America/Indiana/Indianapolis
            - America/Juneau
            - America/La_Paz
            - America/Lima
            - America/Los_Angeles
            - America/Mazatlan
            - America/Mexico_City
            - America/Monterrey
            - America/Montevideo
            - America/New_York
            - America/Phoenix
            - America/Puerto_Rico
            - America/Regina
            - America/Santiago
            - America/Sao_Paulo
            - America/St_Johns
            - America/Tijuana
            - Asia/Almaty
            - Asia/Baghdad
            - Asia/Baku
            - Asia/Bangkok
            - Asia/Chongqing
            - Asia/Colombo
            - Asia/Dhaka
            - Asia/Hong_Kong
            - Asia/Irkutsk
            - Asia/Jakarta
            - Asia/Jerusalem
            - Asia/Kabul
            - Asia/Kamchatka
            - Asia/Karachi
            - Asia/Kathmandu
            - Asia/Kolkata
            - Asia/Krasnoyarsk
            - Asia/Kuala_Lumpur
            - Asia/Kuwait
            - Asia/Magadan
            - Asia/Muscat
            - Asia/Novosibirsk
            - Asia/Rangoon
            - Asia/Riyadh
            - Asia/Seoul
            - Asia/Shanghai
            - Asia/Singapore
            - Asia/Srednekolymsk
            - Asia/Taipei
            - Asia/Tashkent
            - Asia/Tbilisi
            - Asia/Tehran
            - Asia/Tokyo
            - Asia/Ulaanbaatar
            - Asia/Urumqi
            - Asia/Vladivostok
            - Asia/Yakutsk
            - Asia/Yekaterinburg
            - Asia/Yerevan
            - Atlantic/Azores
            - Atlantic/Cape_Verde
            - Atlantic/South_Georgia
            - Australia/Adelaide
            - Australia/Brisbane
            - Australia/Darwin
            - Australia/Hobart
            - Australia/Melbourne
            - Australia/Perth
            - Australia/Sydney
            - Etc/GMT+12
            - Etc/UTC
            - Europe/Amsterdam
            - Europe/Athens
            - Europe/Belgrade
            - Europe/Berlin
            - Europe/Bratislava
            - Europe/Brussels
            - Europe/Bucharest
            - Europe/Budapest
            - Europe/Copenhagen
            - Europe/Dublin
            - Europe/Helsinki
            - Europe/Istanbul
            - Europe/Kaliningrad
            - Europe/Kiev
            - Europe/Lisbon
            - Europe/Ljubljana
            - Europe/London
            - Europe/Madrid
            - Europe/Minsk
            - Europe/Moscow
            - Europe/Paris
            - Europe/Prague
            - Europe/Riga
            - Europe/Rome
            - Europe/Samara
            - Europe/Sarajevo
            - Europe/Skopje
            - Europe/Sofia
            - Europe/Stockholm
            - Europe/Tallinn
            - Europe/Vienna
            - Europe/Vilnius
            - Europe/Volgograd
            - Europe/Warsaw
            - Europe/Zagreb
            - Europe/Zurich
            - Pacific/Apia
            - Pacific/Auckland
            - Pacific/Chatham
            - Pacific/Fakaofo
            - Pacific/Fiji
            - Pacific/Guadalcanal
            - Pacific/Guam
            - Pacific/Honolulu
            - Pacific/Majuro
            - Pacific/Midway
            - Pacific/Noumea
            - Pacific/Pago_Pago
            - Pacific/Port_Moresby
            - Pacific/Tongatapu
            - UTC
        twilio_number:
          description: The twilio number for the location
          type: string
        whats_app_number:
          description: The whats app for the location
          type: string
        customer_attributes:
          description: List of customer attributes for the location
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - id
        - name
        - location_group
    UpsertLocationParams:
      type: object
      properties:
        address:
          description: The address of the location
          type: string
        country_code:
          description: The country code for the location
          type: string
          enum:
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
        language:
          description: The language for the location
          type: string
          enum:
            - id
            - cs
            - de
            - en-US
            - en-GB
            - es
            - fr
            - it
            - ms
            - nl
            - nn-NO
            - pl
            - pt
            - ro
            - fi
            - sv
            - vi
            - tr
            - uk-UA
            - el
            - bg
            - ru
            - he
            - ar
            - hi-in
            - ta-IN
            - kn-IN
            - bn-IN
            - gu-IN
            - ml-IN
            - mr-IN
            - pa-IN
            - te-IN
            - th
            - ko
            - ja
            - zh-CN
            - zh-TW
        group_id:
          description: Unique identifier for the location group associated to the location
          type: string
        name:
          description: The name of the location
          type: string
        owner_id:
          description: Unique identifier for the location owner
          type: string
        time_zone:
          description: The time zone for the location
          type: string
          enum:
            - Africa/Algiers
            - Africa/Cairo
            - Africa/Casablanca
            - Africa/Harare
            - Africa/Johannesburg
            - Africa/Monrovia
            - Africa/Nairobi
            - America/Argentina/Buenos_Aires
            - America/Bogota
            - America/Caracas
            - America/Chicago
            - America/Chihuahua
            - America/Denver
            - America/Godthab
            - America/Guatemala
            - America/Guyana
            - America/Halifax
            - America/Indiana/Indianapolis
            - America/Juneau
            - America/La_Paz
            - America/Lima
            - America/Los_Angeles
            - America/Mazatlan
            - America/Mexico_City
            - America/Monterrey
            - America/Montevideo
            - America/New_York
            - America/Phoenix
            - America/Puerto_Rico
            - America/Regina
            - America/Santiago
            - America/Sao_Paulo
            - America/St_Johns
            - America/Tijuana
            - Asia/Almaty
            - Asia/Baghdad
            - Asia/Baku
            - Asia/Bangkok
            - Asia/Chongqing
            - Asia/Colombo
            - Asia/Dhaka
            - Asia/Hong_Kong
            - Asia/Irkutsk
            - Asia/Jakarta
            - Asia/Jerusalem
            - Asia/Kabul
            - Asia/Kamchatka
            - Asia/Karachi
            - Asia/Kathmandu
            - Asia/Kolkata
            - Asia/Krasnoyarsk
            - Asia/Kuala_Lumpur
            - Asia/Kuwait
            - Asia/Magadan
            - Asia/Muscat
            - Asia/Novosibirsk
            - Asia/Rangoon
            - Asia/Riyadh
            - Asia/Seoul
            - Asia/Shanghai
            - Asia/Singapore
            - Asia/Srednekolymsk
            - Asia/Taipei
            - Asia/Tashkent
            - Asia/Tbilisi
            - Asia/Tehran
            - Asia/Tokyo
            - Asia/Ulaanbaatar
            - Asia/Urumqi
            - Asia/Vladivostok
            - Asia/Yakutsk
            - Asia/Yekaterinburg
            - Asia/Yerevan
            - Atlantic/Azores
            - Atlantic/Cape_Verde
            - Atlantic/South_Georgia
            - Australia/Adelaide
            - Australia/Brisbane
            - Australia/Darwin
            - Australia/Hobart
            - Australia/Melbourne
            - Australia/Perth
            - Australia/Sydney
            - Etc/GMT+12
            - Etc/UTC
            - Europe/Amsterdam
            - Europe/Athens
            - Europe/Belgrade
            - Europe/Berlin
            - Europe/Bratislava
            - Europe/Brussels
            - Europe/Bucharest
            - Europe/Budapest
            - Europe/Copenhagen
            - Europe/Dublin
            - Europe/Helsinki
            - Europe/Istanbul
            - Europe/Kaliningrad
            - Europe/Kiev
            - Europe/Lisbon
            - Europe/Ljubljana
            - Europe/London
            - Europe/Madrid
            - Europe/Minsk
            - Europe/Moscow
            - Europe/Paris
            - Europe/Prague
            - Europe/Riga
            - Europe/Rome
            - Europe/Samara
            - Europe/Sarajevo
            - Europe/Skopje
            - Europe/Sofia
            - Europe/Stockholm
            - Europe/Tallinn
            - Europe/Vienna
            - Europe/Vilnius
            - Europe/Volgograd
            - Europe/Warsaw
            - Europe/Zagreb
            - Europe/Zurich
            - Pacific/Apia
            - Pacific/Auckland
            - Pacific/Chatham
            - Pacific/Fakaofo
            - Pacific/Fiji
            - Pacific/Guadalcanal
            - Pacific/Guam
            - Pacific/Honolulu
            - Pacific/Majuro
            - Pacific/Midway
            - Pacific/Noumea
            - Pacific/Pago_Pago
            - Pacific/Port_Moresby
            - Pacific/Tongatapu
            - UTC
        twilio_number:
          description: The twilio number for the location
          type: string
        whats_app_number:
          description: The whats app for the location
          type: string
        customer_attributes:
          description: List of customer attributes for the location
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
    Labels:
      type: object
      properties:
        labels:
          type: array
          properties:
            title:
              type: string
            completed:
              type: boolean
          items:
            description: >-
              WARNING: Missing items property in array schema. Missing items
              property has been filled with this AnyType schema.
    LocationGroup:
      type: object
      properties:
        name:
          description: The name of the location group
          type: string
        id:
          description: Unique identifier for the location group
          type: string
        customer_attributes:
          description: List of customer attributes for the location group
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - id
        - name
    LocationGroupDetail:
      type: object
      properties:
        account_id:
          description: Unique identifier for the account
          type: string
        name:
          description: The name of the location group
          type: string
        id:
          description: Unique identifier for the location group
          type: string
        owner:
          description: The name of the location group owner
          type: string
        locations:
          description: List of locations the location group is tied to
          type: array
          items:
            type: object
            properties:
              id:
                description: Unique identifier for the location
                type: string
              name:
                description: The name of the location
                type: string
        customer_attributes:
          description: List of customer attributes for the location group
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - id
        - name
    NotFound:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    OpeningPayRate:
      type: object
      properties:
        compensation:
          description: The pay rate
          type: string
        compensation_currency_code:
          description: The currency of the pay rate
          type: string
        compensation_type:
          description: How often the pay occurs
          type: string
          enum:
            - hour
            - day
            - month
            - year
      required:
        - compensation
        - compensation_currency_code
        - compensation_type
    OpeningStage:
      type: object
      properties:
        title:
          description: Title of the stage
          type: string
        type:
          description: Type of the stage
          type: string
        parent_id:
          description: Unique identifier of the stage's parent
          type: string
          nullable: true
        id:
          description: Unique identifier for the stage
          type: string
        data_fields:
          type: array
          items:
            type: object
            properties:
              key:
                description: The key the data is collected under
                type: string
              type:
                description: The type of the input for the question
                type: string
              question:
                description: Text of the question asked on the form
                type: string
              storage:
                description: >-
                  Where in the applicant payload the response is stored.
                  "applicant" means on the root of the applicant record.
                type: string
                enum:
                  - data
                  - secure_data
                  - applicant
              options:
                type: array
                items:
                  type: object
                  properties:
                    value:
                      description: The value persisted for the option
                      type: string
                    label:
                      description: The human-readable value for the option
                      type: string
                  required:
                    - value
                    - label
            required:
              - key
              - type
              - question
              - storage
      required:
        - id
        - title
        - type
    CreateOptionBankRequest:
      type: object
      properties:
        name:
          description: Name of the Option Bank
          type: string
        options:
          type: array
          items:
            type: object
            properties:
              label:
                description: Display name for the Option Bank
                type: string
              value:
                description: Value for the Option Bank
                type: string
              default:
                description: Default option
                type: boolean
            required:
              - label
              - value
              - default
    IndexOptionBanksResponse:
      type: object
      properties:
        option_banks:
          type: array
          items:
            $ref: '#/components/schemas/OptionsBank'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - option_banks
        - pagination
    OptionsBank:
      type: object
      properties:
        id:
          description: ID of the option bank.
          type: string
        name:
          description: Name of the option bank.
          type: string
      required:
        - id
        - name
    OptionsBankWithOptions:
      type: object
      properties:
        id:
          description: ID of the option bank.
          type: string
        name:
          description: Name of the option bank.
          type: string
        options:
          type: array
          items:
            type: object
            properties:
              label:
                description: Display name for the Option Bank
                type: string
              value:
                description: Value for the Option Bank
                type: string
              default:
                description: Default option
                type: boolean
            required:
              - label
              - value
      required:
        - id
        - name
        - options
    PaginateJsonSchemaVersionOneOfMany:
      type: object
      properties:
        current_page:
          type: integer
        next_page:
          type: integer
          nullable: true
        per_page:
          type: integer
        total_count:
          type: integer
        total_pages:
          type: integer
      required:
        - current_page
        - next_page
        - per_page
        - total_count
        - total_pages
    Pagination:
      type: object
      properties:
        first:
          description: The first available page
          type: integer
        last:
          description: The last available page
          type: integer
        previous:
          description: The previous page
          type: integer
          nullable: true
        current:
          description: The current page
          type: integer
        next:
          description: The next available page
          type: integer
          nullable: true
    PaginationWithCursor:
      allOf:
        - $ref: '#/components/schemas/Pagination'
        - type: object
          properties:
            current_cursor:
              description: Cursor value for the current page
              type: string
            next_cursor:
              description: Cursor value for the next page
              type: string
    Position:
      type: object
      properties:
        name:
          description: The name of the position
          type: string
        id:
          description: Unique identifier for the position
          type: string
        customer_attributes:
          description: List of customer attributes for the position
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - id
        - name
    PositionDetail:
      type: object
      properties:
        description:
          description: The description of the position
          type: string
        account_id:
          description: Unique identifier for the account
          type: string
        confirmation_message:
          description: The confirmation message to be sent to applicants
          type: string
        name:
          description: The name of the position
          type: string
        id:
          description: Unique identifier for the position
          type: string
        openings_count:
          description: The number of openings the position is associated to
          type: integer
          nullable: true
        openings:
          description: List of openings the position is tied to
          type: array
          items:
            type: object
            properties:
              title:
                description: The title of the opening
                type: string
              id:
                description: Unique identifier for the opening
                type: string
        requirements:
          description: The requirements of the position
          type: string
        customer_attributes:
          description: List of customer attributes for the position
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - account_id
        - id
        - name
    Session:
      type: object
      properties:
        title:
          description: The name of the session
          type: string
          nullable: true
        id:
          description: The unique identifier of the available slot
          type: string
        max_attendees:
          description: Maximum number of applicants that can attend
          type: integer
        stage_ids:
          description: List of unique identifiers of stages
          type: array
          items:
            type: string
        user_id:
          description: Unique identifier of the slot owner
          type: string
        booked_slots_count:
          description: Count of booked slots for the available slot
          type: integer
        date:
          description: The date of the available slot
          type: string
          format: date
        start_time:
          description: The start time of the available slot
          type: string
          format: datetime
        end_time:
          description: The end time of the available slot
          type: string
          format: datetime
        location:
          description: The location of the available slot
          type: string
        instructions:
          description: Instructions for attendees
          type: string
          nullable: true
        unbooked_siblings_count:
          description: Count of unbooked available slots with identical keys
          type: integer
          nullable: true
        booked_siblings_count:
          description: Count of booked available slots with identical keys
          type: integer
          nullable: true
        live_video_room_url:
          description: URL for available slot online location
          type: string
          nullable: true
        any_stage_has_video_enabled:
          description: Indicates whether any stage is a live video stage
          type: boolean
          nullable: true
        event_type:
          description: The type of the event
          type: string
        instant_interview_enabled:
          description: Indicates whether the event type is instant interview
          type: boolean
        booked_slots:
          description: List of booked slots for the available slot
          type: array
          items:
            $ref: '#/components/schemas/SessionBookedSlot'
      required:
        - id
        - booked_slots_count
        - start_time
        - end_time
        - date
        - event_type
        - instant_interview_enabled
    Shift:
      type: object
      properties:
        description:
          description: Description of the position
          type: string
        name:
          description: The name of the shift
          type: string
        id:
          type: integer
        days_of_week:
          description: The days the shift occurs on
          type: array
          items:
            type: string
            enum:
              - mon
              - tue
              - wed
              - thu
              - fri
              - sat
              - sun
        hours:
          type: object
          properties:
            start_time:
              description: The time the shift starts
              type: integer
            end_time:
              description: The time the shift ends
              type: integer
        customer_attributes:
          description: List of customer attributes for the position
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - days_of_week
        - hours
        - id
    Stage:
      type: object
      properties:
        title:
          description: The title of the stage
          type: string
        id:
          description: Unique identifier for the stage
          type: string
        type:
          description: The type of the stage
          type: string
        parent_id:
          description: The unique identifier for the parent stage
          type: string
          nullable: true
        position:
          description: The position of the stage in the opening
          type: integer
        num_applicants:
          description: The number of applicants in the stage
          type: integer
      required:
        - id
        - title
        - type
        - position
        - num_applicants
    User:
      type: object
      properties:
        name:
          description: The name of the user
          type: string
        id:
          description: Unique identifier for the user
          type: string
        email:
          description: The email of the user
          type: string
      required:
        - id
        - name
        - email
    Unauthorized:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    Worker:
      type: object
      properties:
        is_active:
          type: boolean
        name:
          type: string
        email:
          type: string
        id:
          type: string
        approved_at:
          type: string
      required:
        - is_active
        - name
        - email
        - id
        - approved_at
        - data_collection_checks
    WorkerDataCollectionCheck:
      type: object
      properties:
        id:
          type: string
        requested_at:
          type: string
          nullable: true
        uploaded_at:
          type: string
          nullable: true
        rejected_at:
          type: string
          nullable: true
        confirmed_at:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
        expiration_date:
          type: string
          nullable: true
        status:
          type: string
        confirmed_user:
          type: string
          nullable: true
      required:
        - id
        - requested_at
        - uploaded_at
        - rejected_at
        - confirmed_at
        - canceled_at
        - expiration_date
        - status
        - confirmed_user
    WorkerDataCollectionChecks:
      type: object
      properties:
        data_collection_checks:
          type: array
          items:
            $ref: '#/components/schemas/WorkerDataCollectionCheck'
    WorkerDataCollectionChecksWithDetails:
      type: object
      properties:
        data_collection_checks:
          type: array
          items:
            allOf:
              - $ref: '#/components/schemas/WorkerDataCollectionCheck'
              - type: object
                properties:
                  rule:
                    type: object
                    properties:
                      title:
                        type: string
                      id:
                        type: string
                  uploads:
                    type: array
                    items:
                      type: object
                      properties:
                        created_at:
                          type: string
                        data:
                          description: Data collected about the worker
                          type: object
                        structured_data:
                          description: Structured data collected about the worker
                          type: object
                        files:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                description: Name of the document.
                                type: string
                              friendly_name:
                                description: Friendly name of the document.
                                type: string
                              filename:
                                description: Document filename of file.
                                type: string
                              size:
                                description: Size of document in bytes.
                                type: number
                              approved:
                                type: boolean
                              id:
                                type: string
                              public_url:
                                description: The URL to download the document.
                                type: string
                                format: uri
                              created_at:
                                type: string
                              approved_at:
                                type: string
                                nullable: true
                              stage:
                                type: object
                                properties:
                                  title:
                                    type: string
                                  id:
                                    type: string
                                required:
                                  - id
                                  - title
                                nullable: true
                              file_upload_requests:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    recollection_reason:
                                      description: Reason the upload is being recollected.
                                      type: string
                                      enum:
                                        - blurry
                                        - corrupt
                                        - incorrect
                                        - expired
                                        - custom
                                    created_at:
                                      description: >-
                                        DateTime the re-collection request was
                                        triggered.
                                      type: string
                            required:
                              - name
                              - friendly_name
                              - filename
                              - size
                              - approved
                              - id
                              - public_url
                              - stage
                              - created_at
                              - approved_at
    WorkflowsIndexResponse:
      type: object
      properties:
        workflows:
          type: array
          items:
            type: object
            properties:
              title:
                description: The title of the Workflow.
                type: string
              country_code:
                description: ISO country code
                type: string
              id:
                description: UUID of the workflow
                type: string
              locale:
                description: Language ISO code.
                type: string
              openings_count:
                description: Number of openings in the workflow.
                type: number
              created_at:
                description: Date that the workflow was created.
                type: string
                format: date-time
            required:
              - country_code
              - id
              - locale
              - openings_count
              - title
              - created_at
        pagination:
          $ref: '#/components/schemas/PaginateJsonSchemaVersionOneOfMany'
      required:
        - workflows
        - pagination
    NotImplemented:
      type: object
      properties:
        message:
          type: string
    ApplicantsUpdateInfoRequest:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        phone_number:
          type: string
        data:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: integer
              - type: boolean
              - type: array
                items:
                  description: >-
                    WARNING: Missing items property in array schema. Missing
                    items property has been filled with this AnyType schema.
              - type: object
        secure_data:
          type: object
        rejection_reason:
          type: string
    ApplicantsAdvanceApplicantRequest:
      type: object
      properties:
        stage_id:
          description: >-
            Destination stage's external id. If not provided, the applicant will
            advance to the next stage by default.
          type: string
        funnel_id:
          description: >-
            Destination funnel's external id. If not provided, the applicant
            will stay in the current funnel.
          type: string
        skip_automated_actions:
          description: >-
            Set `true` if you want to skip automated actions when advancing the
            applicant.
          type: boolean
    ApplicantsBulkAdvanceMultipleRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            description: List of Applicant IDs
            type: string
          minItems: 1
          maxItems: 500
        funnel_id:
          description: >-
            Destination funnel's external id. If not provided, the applicant
            will stay in the current funnel.
          type: string
        skip_automated_actions:
          description: >-
            Set `true` if you want to skip automated actions when advancing the
            applicant.
          type: boolean
    ApplicantsBulkTransitionHistoryRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            description: List of Applicant IDs
            type: string
          minItems: 1
          maxItems: 500
    ApplicantsBulkInterviewSessionsRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            description: List of Applicant IDs
            type: string
          minItems: 1
          maxItems: 1000
        funnel_id:
          description: >-
            Destination funnel's external id. If not provided, the applicant
            will stay in the current funnel.
          type: string
        skip_automated_actions:
          description: >-
            Set `true` if you want to skip automated actions when advancing the
            applicant.
          type: boolean
    ApplicantsUploadSecureDocumentToS3Request:
      type: object
      properties:
        filename:
          description: path/to/file.upload
          type: string
    ApplicantsLinkUploadRequest:
      type: object
      properties:
        s3_key:
          description: The key to upload to S3
          type: string
        key:
          description: Fountains file identifier.
          type: string
    CalendarSlotsCreateNewAvailableRequest:
      type: object
      properties:
        title:
          description: Name of the event
          type: string
        recruiter_email:
          description: Email address of the recruiter
          type: string
        start_time:
          description: Start time of the appointment slot
          type: string
        end_time:
          description: End time of the appointment slot
          type: string
        location:
          description: Location of the appointment slot
          type: string
        max_attendees:
          description: Maximum number of attendees, must be greater than 0
          type: integer
        instructions:
          description: Instructions for attendees
          type: string
        frequency:
          description: Number of days or weeks to repeat the slot
          type: integer
        split:
          description: Number of minutes to split each session into
          type: integer
        period:
          description: Time period to repeat the slot
          type: string
          enum:
            - days
            - weeks
            - weekdays
        stage_ids:
          type: array
          items:
            description: Identifiers for stages to associate with the new slot
            type: string
        opening_stage_ids:
          description: >-
            Identifiers for stage and opening pairs, used for workflow enabled
            stages. Will fail if stage is not associated with the opening
          type: array
          items:
            type: object
            properties:
              funnel_id:
                description: Identifier for opening
                type: string
              stage_id:
                description: Identifier for stage
                type: string
      required:
        - recruiter_email
        - start_time
        - end_time
        - max_attendees
    OpeningsAndStagesCreateOpeningRequest:
      type: object
      properties:
        title:
          description: The title of the opening
          type: string
        location_id:
          description: The unique identifier for the location associated to the opening
          type: string
        position_id:
          description: The unique identifier for the position associated to the opening
          type: string
        use_workflow:
          description: Indicator for whether to create a new workflow based on the opening
          type: boolean
          nullable: true
        workflow_id:
          description: The unique identifier for the workflow to associate to the opening
          type: string
          nullable: true
        workflow_attributes:
          description: >-
            Provide override values for workflow being created or cloned. For
            use in combination with "use_workflow" or "clone_workflow_id"
          type: object
          properties:
            title:
              type: string
          nullable: true
        clone_workflow_id:
          description: >-
            The unique identifier for a workflow to clone and then associate the
            clone to the opening
          type: string
          nullable: true
        active:
          description: Indicator for whether the opening is active
          type: boolean
          nullable: true
        additional_info:
          description: Additional info about the opening
          type: string
          nullable: true
        alternative_locales:
          description: List of alternate locales
          type: array
          items:
            description: Locale identifier
            type: string
          nullable: true
        compensation:
          description: The pay rate
          type: string
          nullable: true
        compensation_currency_code:
          description: The currency of the pay rate
          type: string
          nullable: true
        compensation_type:
          description: How often the pay occurs
          type: string
          enum:
            - hour
            - day
            - month
            - year
          nullable: true
        custom_id:
          description: Identifier custom to opening for the account
          type: string
          nullable: true
        do_launch_portal_from_form:
          description: >-
            Indicator for whether to launch the applicant into the workflow
            after application
          type: boolean
          nullable: true
        force_applicant_identity:
          description: Indicator for whether applicant identity is enforced
          type: boolean
          nullable: true
        is_private:
          description: Indicator for whether the opening is private
          type: boolean
          nullable: true
        is_hiring_funnel:
          description: Indicator for whether the opening is for hiring
          type: boolean
          nullable: true
        is_sourcing_funnel:
          description: Indicator for whether the opening is for sourcing
          type: boolean
          nullable: true
        job_hours:
          description: Indicator for whether the opening is full or part time
          type: string
          enum:
            - full_time
            - part_time
          nullable: true
        job_type:
          description: The type of job represented by the opening
          type: string
          enum:
            - permanent
            - temporary
            - contract_freelancer
            - casual
            - finance_plus_accounting
            - operations_leadership
            - all_other_administrative_plus_professional
            - information_technology
            - customer_service_plus_operations
            - local
            - regional
            - trainee
          nullable: true
        job_industry:
          description: Industry the opening is for
          type: string
          enum:
            - accounting
            - agriculture
            - audio_visual
            - automotive
            - banking_and_finance
            - construction
            - consultancy
            - customer_service_and_call_centres
            - dental
            - education_and_training
            - electronics
            - energy_oil_and_gas
            - engineering
            - environmental_and_waste
            - facilities_management
            - food_hospitality
            - hair_beauty_and_cosmetics
            - health_medical_and_related
            - human_resources
            - insurance
            - it_and_internet
            - legal
            - logistics_procurement_distribution_and_supply_chain
            - manufacturing_and_production
            - marketing_advertising_and_pr
            - media_new_media_and_creative
            - military_and_defence
            - mining
            - nonprofit
            - other
            - property_and_real-estate
            - recruitment
            - retail
            - sales
            - scientific_and_pharmaceuticals
            - secretarial_and_administration
            - telecommunications
            - training
            - travel_leisure_and_tourism
            - transportation
            - web_html_info_design
            - writing_editing
          nullable: true
        owner_id:
          description: The unique identifier for the owner to be associated to the opening
          type: string
          nullable: true
        shift_id:
          description: The unique identifier for the shift to be associated to the opening
          type: string
          nullable: true
        use_obiq_form:
          description: Indicator for whether an external application form will be used
          type: boolean
          nullable: true
        customer_attributes:
          description: List of customer attributes for the opening
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
        shift_attributes:
          description: The values to define a new shift for the opening
          $ref: '#/components/schemas/Shift'
          nullable: true
      required:
        - title
        - location_id
        - position_id
    OpeningsAndStagesUpdateOpeningRequest:
      type: object
      properties:
        title:
          description: The title of the opening
          type: string
          nullable: true
        location_id:
          description: The unique identifier for the location associated to the opening
          type: string
          nullable: true
        position_id:
          description: The unique identifier for the position associated to the opening
          type: string
          nullable: true
        workflow_id:
          description: The unique identifier for the workflow to associate to the opening
          type: string
          nullable: true
        active:
          description: Indicator for whether the opening is active
          type: boolean
          nullable: true
        additional_info:
          description: Additional info about the opening
          type: string
          nullable: true
        alternative_locales:
          description: List of alternate locales
          type: array
          items:
            description: Locale identifier
            type: string
          nullable: true
        compensation:
          description: The pay rate
          type: string
          nullable: true
        compensation_currency_code:
          description: The currency of the pay rate
          type: string
          nullable: true
        compensation_type:
          description: How often the pay occurs
          type: string
          enum:
            - hour
            - day
            - month
            - year
          nullable: true
        custom_id:
          description: Identifier custom to opening for the account
          type: string
          nullable: true
        do_launch_portal_from_form:
          description: >-
            Indicator for whether to launch the applicant into the workflow
            after application
          type: boolean
          nullable: true
        force_applicant_identity:
          description: Indicator for whether applicant identity is enforced
          type: boolean
          nullable: true
        is_private:
          description: Indicator for whether the opening is private
          type: boolean
          nullable: true
        is_hiring_funnel:
          description: Indicator for whether the opening is for hiring
          type: boolean
          nullable: true
        is_sourcing_funnel:
          description: Indicator for whether the opening is for sourcing
          type: boolean
          nullable: true
        job_hours:
          description: Indicator for whether the opening is full or part time
          type: string
          enum:
            - full_time
            - part_time
          nullable: true
        job_type:
          description: The type of job represented by the opening
          type: string
          enum:
            - permanent
            - temporary
            - contract_freelancer
            - casual
            - finance_plus_accounting
            - operations_leadership
            - all_other_administrative_plus_professional
            - information_technology
            - customer_service_plus_operations
            - local
            - regional
            - trainee
          nullable: true
        job_industry:
          description: Industry the opening is for
          type: string
          enum:
            - accounting
            - agriculture
            - audio_visual
            - automotive
            - banking_and_finance
            - construction
            - consultancy
            - customer_service_and_call_centres
            - dental
            - education_and_training
            - electronics
            - energy_oil_and_gas
            - engineering
            - environmental_and_waste
            - facilities_management
            - food_hospitality
            - hair_beauty_and_cosmetics
            - health_medical_and_related
            - human_resources
            - insurance
            - it_and_internet
            - legal
            - logistics_procurement_distribution_and_supply_chain
            - manufacturing_and_production
            - marketing_advertising_and_pr
            - media_new_media_and_creative
            - military_and_defence
            - mining
            - nonprofit
            - other
            - property_and_real-estate
            - recruitment
            - retail
            - sales
            - scientific_and_pharmaceuticals
            - secretarial_and_administration
            - telecommunications
            - training
            - travel_leisure_and_tourism
            - transportation
            - web_html_info_design
            - writing_editing
          nullable: true
        owner_id:
          description: The unique identifier for the owner to be associated to the opening
          type: string
          nullable: true
        shift_id:
          description: The unique identifier for the shift to be associated to the opening
          type: string
          nullable: true
        use_obiq_form:
          description: Indicator for whether an external application form will be used
          type: boolean
          nullable: true
        customer_attributes:
          description: List of customer attributes for the opening
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
        shift_attributes:
          description: >-
            The values to update an existing shift or define a new shift for the
            opening
          $ref: '#/components/schemas/Shift'
          nullable: true
    HiringGoalsCreateNewGoalRequest:
      type: object
      properties:
        start_date:
          description: Start date of the Hiring Goal
          type: string
        hire_by:
          description: The date that the Hiring Goal ends
          type: string
        goal:
          description: The number of hires needed for this Hiring Goal
          type: string
        opening_id:
          description: >-
            The id of the Opening (also known as Funnel) this Hiring Goal
            applies to
          type: string
      required:
        - start_date
        - hire_by
        - goal
        - opening_id
    HiringGoalsUpdateExistingGoalRequest:
      type: object
      properties:
        start_date:
          description: Start date of the Hiring Goal
          type: string
        hire_by:
          description: The date that the Hiring Goal ends
          type: string
        goal:
          description: The number of hires needed for this Hiring Goal
          type: string
        opening_id:
          description: The Opening (also known as Funnel) this Hiring Goal applies to
          type: boolean
          nullable: true
    LocationsAndLocationGroupsCreateLocationGroupRequest:
      type: object
      properties:
        name:
          description: The name of the location group
          type: string
        owner_id:
          description: Unique identifier for the location group owner
          type: string
        customer_attributes:
          description: List of customer attributes for the location group
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - name
    LocationsAndLocationGroupsUpdateLocationGroupRequest:
      type: object
      properties:
        name:
          description: The name of the location group
          type: string
        owner_id:
          description: Unique identifier for the location group owner
          type: string
        move_to_group_id:
          description: >-
            Unique identifier for the location group to move all locations in
            this group to
          type: string
        customer_attributes:
          description: List of customer attributes for the location group
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - name
    OpeningsReassignToWorkflowRequest:
      type: object
      properties:
        destination_workflow_id:
          type: string
          nullable: false
        destination_workflow_title:
          type: string
          nullable: true
        run_landing_actions:
          type: boolean
          nullable: false
        source_opening_id:
          type: string
          nullable: false
        stage_mappings:
          type: array
          items:
            type: object
            properties:
              source_stage_id:
                type: string
                nullable: false
              destination_stage_id:
                type: string
                nullable: false
          nullable: true
      required:
        - destination_workflow_id
        - destination_workflow_title
        - run_landing_actions
        - source_opening_id
        - stage_mappings
    PositionsCreateNewPositionRequest:
      type: object
      properties:
        description:
          description: The description of the position
          type: string
        confirmation_message:
          description: The confirmation message to be sent to applicants
          type: string
        name:
          description: The name of the position
          type: string
        requirements:
          description: The requirements of the position
          type: string
        customer_attributes:
          description: List of customer attributes for the position
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
      required:
        - name
    PositionsUpdateExistingPositionRequest:
      type: object
      properties:
        description:
          description: The description of the position
          type: string
        confirmation_message:
          description: The confirmation message to be sent to applicants
          type: string
        name:
          description: The name of the position
          type: string
        requirements:
          description: The requirements of the position
          type: string
        customer_attributes:
          description: List of customer attributes for the position
          type: array
          items:
            $ref: '#/components/schemas/CustomerAttribute'
          nullable: true
    PosthireWorkerManagementUpdateWorkerRequest:
      type: boolean
    ApplicantsDeleteByIdResponse:
      type: string
      nullable: true
    NotesDeleteApplicantNoteResponse:
      type: string
      nullable: true
    CalendarSlotsCreateNewAvailableResponse:
      type: array
      items:
        $ref: '#/components/schemas/AvailableSlot'
    CalendarSlotsDestroyByIdResponse:
      type: string
      nullable: true
    DataKeysListResponse:
      type: object
      properties:
        data_keys:
          type: array
          items:
            $ref: '#/components/schemas/DataKey'
    OpeningsAndStagesListAllResponse:
      type: object
      properties:
        funnels:
          type: array
          items:
            $ref: '#/components/schemas/Funnel'
        pagination:
          $ref: '#/components/schemas/Pagination'
    HiringGoalsListGoalsResponse:
      type: object
      properties:
        funnels:
          type: array
          items:
            $ref: '#/components/schemas/HiringGoal'
        pagination:
          $ref: '#/components/schemas/Pagination'
    LocationsAndLocationGroupsListResponse:
      type: object
      properties:
        location_groups:
          type: array
          items:
            type: object
            properties:
              account_id:
                description: Unique identifier for the account
                type: string
              id:
                description: Unique identifier for the location group
                type: string
              name:
                description: The name of the location group
                type: string
            required:
              - account_id
              - id
              - name
        pagination:
          $ref: '#/components/schemas/Pagination'
    LocationsAndLocationGroupsListLocationsResponse:
      type: object
      properties:
        locations:
          type: array
          items:
            type: object
            properties:
              account_id:
                description: Unique identifier for the account
                type: string
              id:
                description: Unique identifier for the location
                type: string
              address:
                description: Address for the location
                type: string
              street_address:
                description: Street address of the location
                type: string
              city:
                description: City of the location
                type: string
              state_code:
                description: State code of the location
                type: string
              postal_code:
                description: Postal code of the location
                type: string
              country_code:
                description: Country code of the location
                type: string
              location_group:
                type: object
                properties:
                  id:
                    description: Unique identifier for the location group
                    type: string
                  name:
                    description: The name for the location group
                    type: string
                  owner:
                    description: The owner of the location group
                    type: string
                required:
                  - id
                  - name
                  - owner
              name:
                description: The name of the location
                type: string
            required:
              - account_id
              - id
              - name
              - location_group
        pagination:
          $ref: '#/components/schemas/Pagination'
    OptionBankDeleteBankResponse:
      type: string
      nullable: true
    OptionBankRemoveOptionResponse:
      type: object
      properties:
        option_bank:
          $ref: '#/components/schemas/OptionsBankWithOptions'
    OptionBankAppendOptionResponse:
      type: object
      properties:
        option_bank:
          $ref: '#/components/schemas/OptionsBankWithOptions'
    PositionsListAllResponse:
      type: object
      properties:
        positions:
          type: array
          items:
            type: object
            properties:
              account_id:
                description: Unique identifier for the account
                type: string
              id:
                description: Unique identifier for the position
                type: string
              name:
                description: The name of the position
                type: string
            required:
              - account_id
              - id
              - name
        pagination:
          $ref: '#/components/schemas/Pagination'
    CalendarSlotsListBookedResponse:
      type: object
      properties:
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/Session'
        pagination:
          $ref: '#/components/schemas/PaginationWithCursor'
        export_enabled:
          type: boolean
    ShiftsListShiftsResponse:
      type: object
      properties:
        shifts:
          type: array
          items:
            $ref: '#/components/schemas/Shift'
    CalendarSlotsGetAvailableSlotsResponse:
      type: object
      properties:
        slots:
          type: array
          items:
            $ref: '#/components/schemas/AvailableSlot'
        pagination:
          $ref: '#/components/schemas/Pagination'
    OpeningsAndStagesListOpeningStagesResponse:
      type: object
      properties:
        stages:
          type: array
          items:
            $ref: '#/components/schemas/OpeningStage'
    UsersGetActivitiesResponse:
      type: object
      properties:
        activities:
          type: array
          items:
            type: object
            properties:
              activity_type:
                type: string
              owner_id:
                type: integer
              id:
                type: integer
              owner_type:
                type: string
              applicant_id:
                type: string
                nullable: true
              created_at:
                type: string
              activity:
                type: object
                properties:
                  field:
                    type: string
                  template_id:
                    type: string
                  email_subject:
                    type: string
                  validation_group_title:
                    type: string
                  funnel_title:
                    description: The title of the opening
                    type: string
                  stage_title:
                    description: The stage title
                    type: string
                  stage_id:
                    description: Unique identifier for the stage
                    type: string
    UsersListAccessedAllResponse:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
    PosthireWorkerManagementListWorkersResponse:
      type: object
      properties:
        workers:
          type: array
          items:
            allOf:
              - $ref: '#/components/schemas/Worker'
              - $ref: '#/components/schemas/WorkerDataCollectionChecks'
        pagination:
          $ref: '#/components/schemas/Pagination'
    PosthireWorkerManagementGetWorkerDataResponse:
      allOf:
        - $ref: '#/components/schemas/Worker'
        - $ref: '#/components/schemas/WorkerDataCollectionChecksWithDetails'
    PosthireWorkerManagementUpdateWorkerResponse:
      allOf:
        - $ref: '#/components/schemas/Worker'
        - $ref: '#/components/schemas/WorkerDataCollectionChecks'
security:
  - ApiKeyAuth: []
x-readme:
  explorer-enabled: true
  proxy-enabled: true
_id: 64e38fdbcde20500430b8d1d