Greenhouse Pending Hires API

openapi: 3.2.0
info:
  title: Greenhouse Pending Hires API
  version: v1
  description: 'Operations tagged Pending Hires across 2 of this provider''s published API definitions: greenhouse-onboarding-v1-openapi.json, greenhouse-onboarding-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://onboarding-api.greenhouse.io
security:
- bearer: []
tags:
- name: Pending Hires
paths:
  /v1/pending_hires:
    post:
      summary: Create Pending Hire
      tags:
      - Pending Hires
      security:
      - oauth2:
        - v1:pending_hires:create
      - bearer: []
      parameters: []
      responses:
        '201':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  employee_id:
                    type:
                    - integer
                    - 'null'
                  email:
                    type:
                    - string
                    - 'null'
                  first_name:
                    type:
                    - string
                    - 'null'
                  last_name:
                    type:
                    - string
                    - 'null'
                  origin_type:
                    type: string
                    enum:
                    - greenhouse
                    - custom
                    - adp
                    - in_app
                    - gho_api
                  origin_id:
                    type:
                    - string
                    - 'null'
                  webhook_data_id:
                    type:
                    - integer
                    - 'null'
                  notified:
                    type:
                    - boolean
                    - 'null'
                  preferred_first_name:
                    type:
                    - string
                    - 'null'
                  preferred_last_name:
                    type:
                    - string
                    - 'null'
                  application_id:
                    type:
                    - integer
                    - 'null'
                  candidate_id:
                    type:
                    - integer
                    - 'null'
                  about:
                    type:
                    - string
                    - 'null'
                  date_of_birth:
                    type:
                    - string
                    - 'null'
                  department_id:
                    type:
                    - integer
                    - 'null'
                  employment_status:
                    type:
                    - string
                    - 'null'
                  hr_manager_id:
                    type:
                    - integer
                    - 'null'
                  location_id:
                    type:
                    - integer
                    - 'null'
                  manager_id:
                    type:
                    - integer
                    - 'null'
                  personal_email:
                    type:
                    - string
                    - 'null'
                  phone_number:
                    type:
                    - string
                    - 'null'
                  start_date:
                    type:
                    - string
                    - 'null'
                  title:
                    type:
                    - string
                    - 'null'
                  work_country_code:
                    type:
                    - string
                    - 'null'
                  custom_field_values:
                    type: array
                    items:
                      type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Validation Error
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - origin_type
              properties:
                employee_id:
                  type: integer
                email:
                  type: string
                  maxLength: 255
                first_name:
                  type: string
                  maxLength: 255
                last_name:
                  type: string
                  maxLength: 255
                origin_type:
                  type: string
                  maxLength: 255
                  enum:
                  - greenhouse
                  - custom
                  - adp
                  - in_app
                  - gho_api
                origin_id:
                  type: string
                  maxLength: 255
                created_at:
                  type: datetime
                updated_at:
                  type: datetime
                webhook_data_id:
                  type: integer
                notified:
                  type: boolean
                preferred_first_name:
                  type: string
                  maxLength: 255
                preferred_last_name:
                  type: string
                  maxLength: 255
                application_id:
                  type: integer
                candidate_id:
                  type: integer
                about:
                  type: string
                date_of_birth:
                  type: date
                department_id:
                  type: integer
                employment_status:
                  type: string
                hr_manager_id:
                  type: integer
                location_id:
                  type: integer
                manager_id:
                  type: integer
                personal_email:
                  type: string
                  maxLength: 255
                phone_number:
                  type: string
                  maxLength: 255
                start_date:
                  type: date
                title:
                  type: string
                  maxLength: 255
                work_country_code:
                  type: string
                  maxLength: 255
                custom_field_values:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    required:
                    - custom_field_id
                    properties:
                      custom_field_id:
                        type: integer
                      value:
                        oneOf:
                        - type: 'null'
                        - type: string
                        - type: object
                          description: Value structure for a contact-type custom field
                          required:
                          - first_name
                          - last_name
                          - relationship
                          properties:
                            first_name:
                              type: string
                            last_name:
                              type: string
                            relationship:
                              type: string
                              enum:
                              - Child
                              - Domestic Partner
                              - Domestic Partner Child
                              - Friend
                              - Grandparent
                              - Parent
                              - Sibling
                              - Spouse
                              - Other
                            email:
                              type:
                              - string
                              - 'null'
                            phone:
                              type:
                              - string
                              - 'null'
      operationId: postV1PendingHires
      x-operation-id-source: derived
    get:
      summary: List pending hires
      tags:
      - Pending Hires
      security:
      - oauth2:
        - v1:pending_hires:list
      - bearer: []
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 100
        description: Number of results per page
      - name: ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: created_at
        in: query
        required: false
        schema:
          type: object
          properties:
            gte:
              type: string
              format: date-time
            lte:
              type: string
              format: date-time
            gt:
              type: string
              format: date-time
            lt:
              type: string
              format: date-time
            any_value:
              type: boolean
            no_value:
              type: boolean
        style: pipeDelimited
      - name: updated_at
        in: query
        required: false
        schema:
          type: object
          properties:
            gte:
              type: string
              format: date-time
            lte:
              type: string
              format: date-time
            gt:
              type: string
              format: date-time
            lt:
              type: string
              format: date-time
            any_value:
              type: boolean
            no_value:
              type: boolean
        style: pipeDelimited
      - name: employee_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: webhook_data_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: origin_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: application_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: candidate_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: fields
        in: query
        required: false
        description: Comma separated list of fields to return
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            pattern: (?i-mx:^(?i-mx:[a-z]+(?:_[a-z]+)*)+(?:,(?i-mx:[a-z]+(?:_[a-z]+)*)+)*$)
          maxItems: 50
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: origin_type
        in: query
        required: false
        schema:
          type: string
          enum:
          - greenhouse
          - custom
          - adp
          - in_app
          - gho_api
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                example_response:
                  value:
                  - id: 1
                    employee_id: null
                    email: email000000000001-64@factory.com
                    first_name: Jake 2
                    last_name: Bingo 2
                    origin_type: greenhouse
                    origin_id: '1'
                    created_at: '2024-01-01T12:30:30.000Z'
                    updated_at: '2024-01-01T12:30:30.000Z'
                    webhook_data_id: null
                    notified: false
                    preferred_first_name: null
                    preferred_last_name: null
                    application_id: null
                    candidate_id: null
                    about: null
                    date_of_birth: null
                    department_id: null
                    employment_status: null
                    hr_manager_id: null
                    location_id: null
                    manager_id: null
                    personal_email: null
                    phone_number: null
                    start_date: null
                    title: null
                    work_country_code: null
                    custom_field_values: []
              schema:
                type: array
                uniqueItems: true
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    id:
                      type: integer
                    created_at:
                      type: string
                      format: date-time
                    updated_at:
                      type: string
                      format: date-time
                    employee_id:
                      type:
                      - integer
                      - 'null'
                    email:
                      type:
                      - string
                      - 'null'
                    first_name:
                      type:
                      - string
                      - 'null'
                    last_name:
                      type:
                      - string
                      - 'null'
                    origin_type:
                      type: string
                      enum:
                      - greenhouse
                      - custom
                      - adp
                      - in_app
                      - gho_api
                    origin_id:
                      type:
                      - string
                      - 'null'
                    webhook_data_id:
                      type:
                      - integer
                      - 'null'
                    notified:
                      type:
                      - boolean
                      - 'null'
                    preferred_first_name:
                      type:
                      - string
                      - 'null'
                    preferred_last_name:
                      type:
                      - string
                      - 'null'
                    application_id:
                      type:
                      - integer
                      - 'null'
                    candidate_id:
                      type:
                      - integer
                      - 'null'
                    about:
                      type:
                      - string
                      - 'null'
                    date_of_birth:
                      type:
                      - string
                      - 'null'
                    department_id:
                      type:
                      - integer
                      - 'null'
                    employment_status:
                      type:
                      - string
                      - 'null'
                    hr_manager_id:
                      type:
                      - integer
                      - 'null'
                    location_id:
                      type:
                      - integer
                      - 'null'
                    manager_id:
                      type:
                      - integer
                      - 'null'
                    personal_email:
                      type:
                      - string
                      - 'null'
                    phone_number:
                      type:
                      - string
                      - 'null'
                    start_date:
                      type:
                      - string
                      - 'null'
                    title:
                      type:
                      - string
                      - 'null'
                    work_country_code:
                      type:
                      - string
                      - 'null'
                    custom_field_values:
                      type: array
                      items:
                        type: object
      operationId: getV1PendingHires
      x-operation-id-source: derived
    servers:
    - url: https://onboarding-api.greenhouse.io
  /v1/pending_hires/{id}:
    delete:
      summary: Delete Pending Hire
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - Pending Hires
      security:
      - oauth2:
        - v1:pending_hires:destroy
      - bearer: []
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                example_response:
                  value:
                    message: Pending Hire 1 deleted successfully
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  message:
                    type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      operationId: deleteV1PendingHiresById
      x-operation-id-source: derived
    patch:
      summary: Update Pending Hires
      tags:
      - Pending Hires
      security:
      - oauth2:
        - v1:pending_hires:update
      - bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                example_response:
                  value:
                    id: 1
                    employee_id: null
                    email: email000000000001-69@factory.com
                    first_name: Updated first_name
                    last_name: Bingo 3
                    origin_type: greenhouse
                    origin_id: '1'
                    created_at: '2024-01-01T00:00:00.000Z'
                    updated_at: '2024-01-01T00:00:00.000Z'
                    webhook_data_id: null
                    notified: false
                    preferred_first_name: null
                    preferred_last_name: null
                    application_id: null
                    candidate_id: null
                    about: null
                    date_of_birth: null
                    department_id: null
                    employment_status: null
                    hr_manager_id: null
                    location_id: null
                    manager_id: null
                    personal_email: null
                    phone_number: null
                    start_date: null
                    title: null
                    work_country_code: null
                    custom_field_values: []
              schema:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  employee_id:
                    type:
                    - integer
                    - 'null'
                  email:
                    type:
                    - string
                    - 'null'
                  first_name:
                    type:
                    - string
                    - 'null'
                  last_name:
                    type:
                    - string
                    - 'null'
                  origin_type:
                    type: string
                    enum:
                    - greenhouse
                    - custom
                    - adp
                    - in_app
                    - gho_api
                  origin_id:
                    type:
                    - string
                    - 'null'
                  webhook_data_id:
                    type:
                    - integer
                    - 'null'
                  notified:
                    type:
                    - boolean
                    - 'null'
                  preferred_first_name:
                    type:
                    - string
                    - 'null'
                  preferred_last_name:
                    type:
                    - string
                    - 'null'
                  application_id:
                    type:
                    - integer
                    - 'null'
                  candidate_id:
                    type:
                    - integer
                    - 'null'
                  about:
                    type:
                    - string
                    - 'null'
                  date_of_birth:
                    type:
                    - string
                    - 'null'
                  department_id:
                    type:
                    - integer
                    - 'null'
                  employment_status:
                    type:
                    - string
                    - 'null'
                  hr_manager_id:
                    type:
                    - integer
                    - 'null'
                  location_id:
                    type:
                    - integer
                    - 'null'
                  manager_id:
                    type:
                    - integer
                    - 'null'
                  personal_email:
                    type:
                    - string
                    - 'null'
                  phone_number:
                    type:
                    - string
                    - 'null'
                  start_date:
                    type:
                    - string
                    - 'null'
                  title:
                    type:
                    - string
                    - 'null'
                  work_country_code:
                    type:
                    - string
                    - 'null'
                  custom_field_values:
                    type: array
                    items:
                      type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Validation Error
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                employee_id:
                  type: integer
                email:
                  type: string
                  maxLength: 255
                first_name:
                  type: string
                  maxLength: 255
                last_name:
                  type: string
                  maxLength: 255
                origin_type:
                  type: string
                  maxLength: 255
                  enum:
                  - greenhouse
                  - custom
                  - adp
                  - in_app
                  - gho_api
                origin_id:
                  type: string
                  maxLength: 255
                created_at:
                  type: datetime
                updated_at:
                  type: datetime
                webhook_data_id:
                  type: integer
                notified:
                  type: boolean
                preferred_first_name:
                  type: string
                  maxLength: 255
                preferred_last_name:
                  type: string
                  maxLength: 255
                application_id:
                  type: integer
                candidate_id:
                  type: integer
                about:
                  type: string
                date_of_birth:
                  type: date
                department_id:
                  type: integer
                employment_status:
                  type: string
                hr_manager_id:
                  type: integer
                location_id:
                  type: integer
                manager_id:
                  type: integer
                personal_email:
                  type: string
                  maxLength: 255
                phone_number:
                  type: string
                  maxLength: 255
                start_date:
                  type: date
                title:
                  type: string
                  maxLength: 255
                work_country_code:
                  type: string
                  maxLength: 255
                custom_field_values:
                  type: array
                  items:
                    type: object
                    additionalProperties: false
                    required:
                    - custom_field_id
                    properties:
                      custom_field_id:
                        type: integer
                      value:
                        oneOf:
                        - type: 'null'
                        - type: string
                        - type: object
                          description: Value structure for a contact-type custom field
                          required:
                          - first_name
                          - last_name
                          - relationship
                          properties:
                            first_name:
                              type: string
                            last_name:
                              type: string
                            relationship:
                              type: string
                              enum:
                              - Child
                              - Domestic Partner
                              - Domestic Partner Child
                              - Friend
                              - Grandparent
                              - Parent
                              - Sibling
                              - Spouse
                              - Other
                            email:
                              type:
                              - string
                              - 'null'
                            phone:
                              type:
                              - string
                              - 'null'
      operationId: patchV1PendingHiresById
      x-operation-id-source: derived
    servers:
    - url: https://onboarding-api.greenhouse.io
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 Authentication
      flows:
        clientCredentials:
          tokenUrl: https://auth.greenhouse.io/token
          scopes:
            v1:bulk_requests:list: List current bulk requests.
            v1:countries:list: List all countries and their subdivisions.
            v1:custom_fields:list: List all of the custom fields.
            v1:documents:list: List all of the documents.
            v1:employees:list: List all of the employees.
            v1:employees:update: Update a single employee.
            v1:other_criteria:list: List all of the other criteria.
            v1:pending_hires:create: Create a single pending hire.
            v1:pending_hires:destroy: Delete a single pending hire.
            v1:pending_hires:list: List all of the pending hires.
            v1:pending_hires:update: Update a single pending hire.
            v1:signature_request_templates:list: List all of the signature request templates.
            v1:signature_requests:list: List all of the signature requests.
            v1:team_categories:list: List all of the team categories.
            v1:teams:create: Create a single team.
            v1:teams:destroy: Delete a single team.
            v1:teams:list: List all of the teams.
            v1:teams:update: Update a single team.
        authorizationCode:
          authorizationUrl: https://auth.greenhouse.io/authorize
          tokenUrl: https://auth.greenhouse.io/token
          refreshUrl: https://auth.greenhouse.io/token
          scopes:
            v1:bulk_requests:list: List current bulk requests.
            v1:countries:list: List all countries and their subdivisions.
            v1:custom_fields:list: List all of the custom fields.
            v1:documents:list: List all of the documents.
            v1:employees:list: List all of the employees.
            v1:employees:update: Update a single employee.
            v1:other_criteria:list: List all of the other criteria.
            v1:pending_hires:create: Create a single pending hire.
            v1:pending_hires:destroy: Delete a single pending hire.
            v1:pending_hires:list: List all of the pending hires.
            v1:pending_hires:update: Update a single pending hire.
            v1:signature_request_templates:list: List all of the signature request templates.
            v1:signature_requests:list: List all of the signature requests.
            v1:team_categories:list: List all of the team categories.
            v1:teams:create: Create a single team.
            v1:teams:destroy: Delete a single team.
            v1:teams:list: List all of the teams.
            v1:teams:update: Update a single team.
x-refined-from:
- greenhouse-onboarding-v1-openapi.json
- greenhouse-onboarding-v1-openapi.yml
x-readme:
  headers: []
x-readme-fauxas: true