openapi: 3.2.0
info:
  title: Api_server_v2_service Service Employee API
  version: 1.0.0
servers:
- url: https://apiv2.{domain}.ai
  variables:
    domain:
      default: eightfold
      enum:
      - eightfold
      - eightfold-eu
      - eightfold-gov
      - eightfold-ca
      - eightfold-wu
      - eightfold-ap
tags:
- name: Employee
paths:
  /api/v2/core/employees:
    post:
      description: Creates a new employee
      operationId: create_employee
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileAsyncSchema'
          description: OK
      summary: Create Employee
      tags:
      - Employee
    get:
      description: List call that returns all the employee profiles.
      operationId: list_employee
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Specifies the offset value to start for the page
        in: query
        name: start
        schema:
          type: integer
      - description: Specifies the number of entries to be returned for the page
        in: query
        name: limit
        schema:
          type: integer
      - description: Filter query using predefined filter arguments documented [here](https://apidocs.eightfold.ai/v2.0/docs#the-filterquery-parameter)
        in: query
        name: filterQuery
        schema:
          type: string
      - description: Any wildcard text to search in position
        in: query
        name: query
        schema:
          type: string
      - description: Include additional fields in the response. Possible values are demandExperiences, temporalFields
        in: query
        name: include
        schema:
          type: string
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeSchema'
          description: OK
      summary: List Employees
      tags:
      - Employee
  /api/v2/core/employees/batch-fetch:
    post:
      description: Batch fetch employees for a given list of profile ids
      operationId: employee_batch_fetch
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Include additional fields in the response. Possible values are demandExperiences, temporalFields
        in: query
        name: include
        schema:
          type: string
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchFetchEntityRequestSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/EmployeeSchema'
                    type: array
                  meta:
                    $ref: '#/components/schemas/BatchFetchMetaSchema'
                type: object
          description: OK
      summary: Batch Fetch Employees
      tags:
      - Employee
  /api/v2/core/employees/role-match-score:
    get:
      description: List call that returns employees match scores against their current roles.
      operationId: list_employee_role_match_score
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Specifies the offset value to start for the page
        in: query
        name: start
        schema:
          type: integer
      - description: Specifies the number of entries to be returned for the page
        in: query
        name: limit
        schema:
          type: integer
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleMatchScoreResponseSchema'
          description: OK
      summary: List Employee Match Scores
      tags:
      - Employee
  /api/v2/core/employees/{employeeId}/matched-positions:
    get:
      description: 'Returns the positions recommended to an employee, at parity with the Career Hub ''Recommended jobs'' feed: the tenant''s Career Hub position visibility rules, feed search overrides, the employee''s job preferences and location, and dismissed jobs all apply, and results are sorted by match score. An empty list means the feed has no recommendations for the employee. By default the Career Hub fallback rows ("Showing other relevant jobs") are not returned; pass fallback=true to get them when the primary feed is empty and the tenant''s feed config enables a fallback. Runs as the employee, so the employee must have a user login and Career Hub enabled. For the recruiter-side ATS match of any profile use /profiles//matched-positions instead. JWT callers need Career Hub position access and can only request their own recommendations.'
      operationId: list_employee_matched_positions
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Eightfold employee profile ID (encoded or decoded), or the employee ID from the HR system. The profile ID is tried first.
        in: path
        name: employeeId
        required: true
        schema:
          type: string
      - description: Specifies the offset value to start for the page
        in: query
        name: start
        schema:
          type: integer
      - description: Specifies the number of entries to be returned for the page
        in: query
        name: limit
        schema:
          type: integer
      - description: Defaults to true. Pass false to skip computing validatedSkills and missingSkills, returning them as empty lists.
        in: query
        name: validatedSkills
        schema:
          type: string
      - description: Defaults to false. Pass true to return the Career Hub fallback rows (the tenant feed config's fallback_config, shown on the home page as 'Showing other relevant jobs') when the primary recommended-jobs feed is empty and the tenant config has should_call_fallback enabled. Fallback rows are not personalised matches.
        in: query
        name: fallback
        schema:
          type: string
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/MatchingPositionsSchema'
                    type: array
                  meta:
                    $ref: '#/components/schemas/MetaSchema'
                type: object
          description: OK
      summary: List Matched Positions for Employee
      tags:
      - Employee
  /api/v2/core/employees/{profileId}:
    get:
      description: Given a profile id of a employee, it returns all attributes of the employee
      operationId: get_employee_by_id
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Eightfold employee profile ID (supports both encoded and decoded ID)
        in: path
        name: profileId
        required: true
        schema:
          type: string
      - description: Include additional fields in the response. Possible values are demandExperiences, temporalFields
        in: query
        name: include
        schema:
          type: string
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeSchema'
          description: OK
      summary: Get Employee
      tags:
      - Employee
    patch:
      description: 'Patches employee given its profile_id. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.'
      operationId: patch_employee
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Eightfold employee profile ID (supports both encoded and decoded)
        in: path
        name: profileId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeAsyncSchema'
          description: OK
      summary: Patch Employee
      tags:
      - Employee
    put:
      description: Updates employee given its profile_id.
      operationId: update_employee
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Eightfold employee profile ID (supports both encoded and decoded)
        in: path
        name: profileId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeAsyncSchema'
          description: OK
      summary: Update Employee
      tags:
      - Employee
  /api/v2/core/employees/{profileId}/matched-demands:
    get:
      description: Returns all the matching demands for an employee profile. Only works for employee profiles, not candidates. By default, demands are filtered by the employee's location and a minimum star rating threshold of 3.5. Results are sorted by match score (highest to lowest). Use ignoreLocation=true to search globally and minStarThreshold to adjust the quality threshold.
      operationId: list_employee_matched_demands
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Employee Profile ID (supports both encoded and decoded ID)
        in: path
        name: profileId
        required: true
        schema:
          type: string
      - description: Specifies the offset value to start for the page
        in: query
        name: start
        schema:
          type: integer
      - description: Specifies the number of entries to be returned for the page
        in: query
        name: limit
        schema:
          type: integer
      - description: Demand Filter Query using predefined filter arguments documented [here](https://apidocs.eightfold.ai/v2.0/docs#the-filterquery-parameter)
        in: query
        name: filterQuery
        schema:
          type: string
      - description: 'When true, applies the same filters used in the Demand Marketplace (Career Hub), including user group access control and configured visibility rules. Default: false'
        in: query
        name: applyMarketplaceFilters
        schema:
          default: false
          type: boolean
      - description: 'When true, applies the same filters used in the Matched Demands widget on the employee profile page in Resource Management. Default: false'
        in: query
        name: applyMatchedDemandsWidgetFilters
        schema:
          default: false
          type: boolean
      - description: 'When true, ignores the profile''s location when matching demands. By default, demands are filtered to match the employee''s location. Default: false'
        in: query
        name: ignoreLocation
        schema:
          default: false
          type: boolean
      - description: 'Minimum star rating threshold (1.0 to 5.0) for matched demands. Only demands with match scores at or above this threshold will be returned. Default: 3.5'
        in: query
        name: minStarThreshold
        schema:
          default: 3.5
          format: float
          maximum: 5
          minimum: 1
          type: number
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/MatchingDemandsSchema'
                    type: array
                  meta:
                    $ref: '#/components/schemas/MetaSchema'
                type: object
          description: OK
      summary: List Matched Demands for Employee
      tags:
      - Employee
  /api/v2/core/employees/{profileId}/recommended-mentors:
    get:
      description: Given a profile ID of an employee, return recommended mentors
      operationId: list_employee_recommended_mentors
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: Specifies the offset value to start for the page
        in: query
        name: start
        schema:
          type: integer
      - description: Specifies the number of entries to be returned for the page
        in: query
        name: limit
        schema:
          type: integer
      - description: Eightfold employee profile ID (supports both encoded and decoded)
        in: path
        name: profileId
        required: true
        schema:
          type: string
      - description: Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: exclude
        schema:
          type: string
      - description: Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.
        in: query
        name: keyList
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/RecommendedMentorSchema'
                    type: array
                  meta:
                    $ref: '#/components/schemas/MetaSchema'
                type: object
          description: OK
      summary: List Recommended Mentors
      tags:
      - Employee
  /api/v2/core/hris-systems/{systemId}/ext-employees/{employeeId}:
    patch:
      description: 'Patches employee given its employee id. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.'
      operationId: patch_HRIS_employee_ext_employees
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: System ID of profile. Use default if you have only one system and dont want to use system-Id.
        in: path
        name: systemId
        required: true
        schema:
          type: string
      - description: Employee unique Id
        in: path
        name: employeeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeAsyncSchema'
          description: OK
      summary: Patch HRIS Employee
      tags:
      - Employee
    put:
      description: Updates employee given its employee id.
      operationId: update_HRIS_employee_ext_employees
      parameters:
      - description: The secret key to access the api. It starts with the bearer token
        in: header
        name: Authorization
        required: true
        schema:
          type: string
      - description: System ID of profile. Use default if you have only one system and dont want to use system-Id.
        in: path
        name: systemId
        required: true
        schema:
          type: string
      - description: Employee unique Id
        in: path
        name: employeeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeAsyncSchema'
          description: OK
      summary: Update HRIS Employee
      tags:
      - Employee
components:
  schemas:
    CertificateSchema:
      type: object
      properties:
        verificationStatus:
          type:
          - string
          - 'null'
          description: verification status of a certification
        country:
          type:
          - string
          - 'null'
          description: Certificate issued country
        skills:
          type:
          - array
          - 'null'
          description: Skills associated with the certification
          items:
            type: string
        comments:
          type:
          - string
          - 'null'
          description: Comments on the certification
        validFromDate:
          type:
          - string
          - 'null'
          description: Valid From Date
        date:
          type:
          - string
          - 'null'
          description: Certificate issue date
        allText:
          type:
          - array
          - 'null'
          description: All text associated with the certification
          items:
            type: string
        source:
          type:
          - string
          - 'null'
          readOnly: true
          description: source
        startDate:
          type:
          - string
          - 'null'
          description: Start date
        validToDate:
          type:
          - string
          - 'null'
          description: Valid To Date
        certificateId:
          type:
          - string
          - 'null'
          description: License number of a certification
        state:
          type:
          - string
          - 'null'
          description: Certificate issued state
        title:
          type:
          - string
          - 'null'
          description: Title of certificate
        endDate:
          type:
          - string
          - 'null'
          description: End date
        verificationBy:
          type:
          - string
          - 'null'
          description: email of the verifier
        externalKey:
          type:
          - string
          - 'null'
          description: External key
        verificationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: verification timestamp
        status:
          type:
          - string
          - 'null'
          description: Certificate status
        certificateType:
          type:
          - string
          - 'null'
          description: Type of certificate
        proficiency:
          type:
          - string
          - 'null'
          description: proficiency of a certification
        attachmentIds:
          type:
          - array
          - 'null'
          description: List of attachment ids of the certification
          items:
            type: string
        certificateExternalId:
          type:
          - string
          - 'null'
          description: external id for the type of certification
        issuingAuthority:
          type:
          - string
          - 'null'
          description: Certificate issuing authority
        description:
          type:
          - string
          - 'null'
          description: Certificate description
      required:
      - title
    ATSSkillGroup:
      type: object
      properties:
        proficiency:
          type:
          - string
          - 'null'
          description: Proficiency
        skillGroup:
          type:
          - string
          - 'null'
          description: Skill Group
    AtsContent:
      type: object
      properties:
        extension:
          type:
          - string
          - 'null'
          description: extension
        content:
          type:
          - string
          - 'null'
          description: content
        isBase64:
          type:
          - boolean
          - 'null'
          description: is base 64 encoded?
    SkillAssessmentMetadata:
      type: object
      properties:
        last_manager_assessment_by:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: profile ID of the manager submitting the manager assessment
        last_manager_assessment_ts:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: The timestamp of last submission of manager assessment
        last_self_assessment_by:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: profile ID of the employee submitting the self assessment
        last_self_assessment_ts:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: The timestamp of last submission of self assessment
    EmployeePerformanceRating:
      type: object
      properties:
        periodEndDate:
          type:
          - string
          - 'null'
          description: The performance period end date
        rating:
          type:
          - number
          - 'null'
          format: float
          description: The rating given
        reviewedBy:
          description: The reviewer info
          allOf:
          - $ref: '#/components/schemas/User'
        ratingLabel:
          type:
          - string
          - 'null'
          description: The rating level
        reviewComments:
          type:
          - string
          - 'null'
          description: The review comments
        periodStartDate:
          type:
          - string
          - 'null'
          description: The performance period start date
        reviewType:
          type:
          - string
          - 'null'
          description: The review type
    EmployeeAsyncSchema:
      type: object
      properties:
        transactionId:
          type:
          - string
          - 'null'
          readOnly: true
          description: ''
    RoleMatchScoreResponseSchema:
      type: object
      properties:
        employeeId:
          type:
          - string
          - 'null'
          readOnly: true
          description: The unique id of the Employee in the HRIS system
        jobCode:
          type:
          - string
          - 'null'
          readOnly: true
          description: The job code of the employee
        matchScores:
          readOnly: true
          description: Match score details against employee's current role
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeeMatchScoreSchema'
        profileId:
          type:
          - string
          - 'null'
          readOnly: true
          description: Encoded employee profile ID in Eightfold Career Hub
    AtsCertificationSchema:
      type: object
      properties:
        locationCountry:
          type:
          - string
          - 'null'
          description: Country where certification was issued
        verificationStatus:
          type:
          - string
          - 'null'
          description: verification status of a certification
        licenseNo:
          type:
          - string
          - 'null'
          description: License number of a certification
        skills:
          type:
          - array
          - 'null'
          description: Skills associated with the certification
          items:
            type: string
        validFromTs:
          type:
          - integer
          - 'null'
          format: int32
          description: validtion from timestamp of a certification
        comments:
          type:
          - string
          - 'null'
          description: Comments on the certification
        allText:
          type:
          - string
          - 'null'
          description: All text associated with the certification
        endTs:
          type:
          - integer
          - 'null'
          format: int32
          description: ending timestamp of a certification
        verificationBy:
          type:
          - string
          - 'null'
          description: email of the verifier
        certificateName:
          type:
          - string
          - 'null'
          description: certificate name of a certification
        verificationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: verification timestamp
        status:
          type:
          - string
          - 'null'
          description: Status of the certification
        certificateType:
          type:
          - string
          - 'null'
          description: Type of the certification
        proficiency:
          type:
          - string
          - 'null'
          description: proficiency of a certification
        validToTs:
          type:
          - integer
          - 'null'
          format: int32
          description: validation till timestamp of a certification
        attachmentIds:
          type:
          - array
          - 'null'
          description: List of attachment ids of a certification
          items:
            type: string
        startTs:
          type:
          - integer
          - 'null'
          format: int32
          description: starting timestamp of a certification
        certificateExternalId:
          type:
          - string
          - 'null'
          description: external id for the type of certification
        locationState:
          type:
          - string
          - 'null'
          description: State where certification was issued
        issuingAuthority:
          type:
          - string
          - 'null'
          description: issuing authority of a certification
        description:
          type:
          - string
          - 'null'
          description: Description of the certification
      required:
      - certificateName
    AtsNoteSchema:
      type: object
      properties:
        subject:
          type:
          - string
          - 'null'
          description: subject of a note
        to:
          type:
          - string
          - 'null'
          description: email of reciever
        noteType:
          type:
          - string
          - 'null'
          description: 'Note type of an ats note. Valid inputs: email, note, other'
        visibility:
          type:
          - string
          - 'null'
          description: visibility of a note
        creator:
          type:
          - string
          - 'null'
          description: creator of a note
        cc:
          type:
          - array
          - 'null'
          description: email address for cc
          items:
            type: string
        body:
          type:
          - string
          - 'null'
          description: body of a note
        sender:
          type:
          - string
          - 'null'
          description: email of sender
        creationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: creation timestamp of a note
    AtsQuestionAnswer:
      type: object
      properties:
        formName:
          type:
          - string
          - 'null'
          description: form name for the question
        choices:
          type:
          - array
          - 'null'
          description: choices of a question
          items:
            type: string
        explanation:
          type:
          - string
          - 'null'
          description: explaination of the question
        answer:
          type:
          - array
          - 'null'
          description: answer to the question
          items:
            type: string
        formType:
          type:
          - string
          - 'null'
          description: form type for the question
        questionId:
          type: string
          description: question id
        displayOrder:
          type:
          - string
          - 'null'
          description: display order of the question
        formId:
          type:
          - string
          - 'null'
          description: form id for the question
        type:
          type:
          - string
          - 'null'
          description: 'Type of question. Valid inputs: text, choice, dropdown, date, multi_value, numeric'
        question:
          type:
          - string
          - 'null'
          description: question data
      required:
      - questionId
    BatchFetchEntityRequestSchema:
      type: object
      properties:
        entityIds:
          type: array
          description: list of entity ids to fetch the entity objects
          items:
            type: string
      required:
      - entityIds
    ProfileSkillSchema:
      type: object
      properties:
        displayName:
          type:
          - string
          - 'null'
          readOnly: true
          description: Display name of the skill
        evaluations:
          description: Latest assessments of the skill as provided by the employee/candidate or the employee's manager
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProfileSkillEvaluation'
        source:
          description: Source of skill, if this was sent by an external system other than the primary HRIS
          allOf:
          - $ref: '#/components/schemas/Source1'
        name:
          type:
          - string
          - 'null'
          description: Normalized skill name
    TemporalField:
      type: object
      properties:
        valueTimeline:
          description: The value timeline of the temporal field
          type: array
          items:
            $ref: '#/components/schemas/TemporalFieldValue'
        name:
          type: string
          description: The name of the temporal field
      required:
      - name
      - valueTimeline
    AtsScorecard:
      type: object
      properties:
        overallRatingLabel:
          type:
          - string
          - 'null'
          description: overall rating label
        overallRating:
          type:
          - string
          - 'null'
          description: 'Overall rating. Valid inputs: strong_yes, yes, mixed, no, strong_no'
        submittedBy:
          description: submitted by
          allOf:
          - $ref: '#/components/schemas/AtsUser'
        submittedAt:
          type:
          - integer
          - 'null'
          format: int32
          description: submitted at timestamp
        interviewedAt:
          type:
          - integer
          - 'null'
          format: int32
          description: interview at timestamp
        attributes:
          description: attributes
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ATSScoreCardAttribute'
        description:
          type:
          - string
          - 'null'
          description: description of interview
        interviewName:
          type:
          - string
          - 'null'
          description: interview name
    EmployeeEmploymentDate:
      type: object
      properties:
        date:
          type:
          - string
          - 'null'
          description: The date itself, as YYYY-MM-DD
        type:
          type: string
          enum:
          - original_hire
          - continuous_service
          - internal_transfer
          - probation_end
          - employment_confirmation
          - last_working_day
          - resignation
          description: Type of lifecycle date. One of ats.base.EmploymentDateType
      required:
      - type
    AtsExperienceSchema:
      type: object
      properties:
        endTs:
          type:
          - integer
          - 'null'
          format: int32
          description: end_ts of exp
        industry:
          type:
          - string
          - 'null'
          description: industry of work
        isInternal:
          type:
          - boolean
          - 'null'
          description: is internal employee
        department:
          type:
          - string
          - 'null'
          description: department of work
        startTs:
          type:
          - integer
          - 'null'
          format: int32
          description: start_ts of exp
        location:
          type:
          - string
          - 'null'
          description: location of work
        company:
          type:
          - string
          - 'null'
          description: company of a candidate
        isCurrent:
          type:
          - boolean
          - 'null'
          description: is currentely employed
        description:
          type:
          - string
          - 'null'
          description: description of the post/company
        title:
          type:
          - string
          - 'null'
          description: title of post
      required:
      - company
      - isCurrent
      - isInternal
      - location
      - startTs
      - title
    EmployeeMatchScoreSchema:
      type: object
      properties:
        matchType:
          type:
          - string
          - 'null'
          readOnly: true
          description: Match score criteria
        rawScore:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: Raw match score in float
        topMatches:
          type:
          - array
          - 'null'
          readOnly: true
          description: Top items matched based on the match type
          items:
            type: string
        score:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: Rounded match score in integer
    AtsAttachmentApplicationMetadataSchema:
      type: object
      properties:
        applicationId:
          type: string
          description: application id for an attachment
      required:
      - applicationId
    AtsProjectSchema:
      type: object
      properties:
        endTs:
          type:
          - integer
          - 'null'
          format: int32
          description: ending timestamp of a project
        links:
          type:
          - array
          - 'null'
          description: links for a project
          items:
            type: string
        startTs:
          type:
          - integer
          - 'null'
          format: int32
          description: start timestamp of a project
        skills:
          type:
          - array
          - 'null'
          description: skills
          items:
            type: string
        company:
          type:
          - string
          - 'null'
          description: company of a project
        contributors:
          type:
          - array
          - 'null'
          description: contributors to a project
          items:
            type: string
        description:
          type:
          - string
          - 'null'
          description: description
        title:
          type:
          - string
          - 'null'
          description: title of a project
      required:
      - company
      - startTs
      - title
    EmployeeSchema:
      type: object
      properties:
        managerEmail:
          type:
          - string
          - 'null'
          description: The email of the manager
        location:
          type:
          - string
          - 'null'
          description: The location of the employee
        awards:
          readOnly: true
          description: Awards listed on employee profile
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Award'
        experiences:
          readOnly: true
          description: Experiences of the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExperienceSchema'
        customInfo:
          type:
          - object
          - 'null'
          description: The custom info captured for the employee by custom fields
        employmentDates:
          description: 'The typed lifecycle dates of the employee, keyed by `type`. A write replaces the whole list: send every date that should survive it. Send [] or null to clear all. Omit the field to leave the stored dates untouched.'
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeeEmploymentDate'
        systemId:
          type:
          - string
          - 'null'
          description: Integration system id for the employee
        languages:
          description: The employee language proficiencies
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeeLanguageProficiency'
        pronouns:
          type:
          - string
          - 'null'
          description: Preferred pronouns of the employee
        externalSystemIds:
          description: 'The employee ids in systems outside the HRIS (payroll and the like). A write replaces the whole list: send every id that should survive it. Send [] or null to clear all. Omit the field to leave the stored ids untouched.'
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeeExternalSystemId'
        terminationRegrettable:
          type:
          - string
          - 'null'
          description: Is the exit regrettable?
        lastActivityTs:
          type:
          - integer
          - 'null'
          format: int32
          description: The last activity timestamp in seconds
        terminationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: The termination timestamp of the employee in seconds
        jobCode:
          type:
          - string
          - 'null'
          description: The job code of the employee
        timezone:
          type:
          - string
          - 'null'
          description: Working time zone
        preferredFirstName:
          type:
          - string
          - 'null'
          description: First name the employee goes by
        role:
          type:
          - string
          - 'null'
          description: The role of the employee
        workplaceModel:
          type:
          - string
          - 'null'
          description: Workplace model (office / hybrid / remote)
        personalEmail:
          type:
          - string
          - 'null'
          description: The personal email of the employee
        isContingent:
          type:
          - boolean
          - 'null'
          description: Is contingent
        mobility:
          description: The mobility of the employee
          allOf:
          - $ref: '#/components/schemas/EmployeeMobility'
        bu:
          type:
          - string
          - 'null'
          description: The Business unit of the employee
        temporalFields:
          description: Temporal fields of the employee
          type: array
          items:
            $ref: '#/components/schemas/TemporalField'
        rmUserGroups:
          description: RM user groups associated with the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmUserGroup'
        maritalStatus:
          type:
          - string
          - 'null'
          description: Marital status of the employee
        externalJobId:
          type:
          - string
          - 'null'
          description: External job id of the employee
        additionalManagers:
          description: The additional managers of the employee. The list sent replaces the stored list; send an empty list to clear all, or omit to leave the existing managers unchanged.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdditionalManager'
        associatedRole:
          readOnly: true
          description: The associated role information of the employee
          allOf:
          - $ref: '#/components/schemas/EmployeeAssociatedRole'
        demandExperiences:
          readOnly: true
          description: List of employee's past demand experiences
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExperienceSchema'
        companyName:
          type:
          - string
          - 'null'
          description: The company name of the employee
        phone:
          type:
          - string
          - 'null'
          description: The phone number of the employee
        managerUserId:
          type:
          - string
          - 'null'
          description: The user id of the manager in HRIS system
        eligibleForTransfer:
          type:
          - boolean
          - 'null'
          description: Is the employee eligible for transfer or not
        lastName:
          type:
          - string
          - 'null'
          description: Last Name of the employee
        employeeType:
          type:
          - string
          - 'null'
          description: Type of the employee
        middleName:
          type:
          - string
          - 'null'
          description: Middle name of the employee
        employmentStatus:
          type:
          - string
          - 'null'
          description: Current employment status
        badges:
          description: The badges of the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeeBadge'
        firstName:
          type:
          - string
          - 'null'
          description: First Name of the employee
        basePay:
          description: The base pay of the employee
          allOf:
          - $ref: '#/components/schemas/Pay'
        education:
          readOnly: true
          description: Education of the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CandidateEducation'
        userId:
          type:
          - string
          - 'null'
          description: The userId of the employee
        businessEmail:
          type:
          - string
          - 'null'
          description: The business email of the employee
        lastReviewRating:
          type:
          - string
          - 'null'
          description: The last review rating of the employee
        employmentBasis:
          type:
          - string
          - 'null'
          description: Employment basis (full-time / part-time)
        lastUpdatedTs:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: The last updated timestamp of the employee profile
        successionPlan:
          description: 'On read: the ids linking this employee to /careerhub/succession_plans, i.e. the plan they are the incumbent of and the plans they are an active successor in. Null when in no plan. Covers position-based succession plans; tenants still on the legacy profile-based model mostly get null. On write: the HRIS succession plan for this employee.'
          allOf:
          - $ref: '#/components/schemas/EmployeeSuccessionPlanLinks'
        patents:
          readOnly: true
          description: Patents listed on employee profile
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Patent'
        bonus:
          description: The bonus given to the employee
          allOf:
          - $ref: '#/components/schemas/Pay'
        managerFullname:
          type:
          - string
          - 'null'
          description: The full name of the manager
        rehireEligibility:
          type:
          - string
          - 'null'
          description: Eligible for rehire?
        userHighlightedSkills:
          type:
          - array
          - 'null'
          description: Skills the employee has highlighted on their Career Hub profile. A write replaces the whole list; an empty list clears it. Only skills already on the profile are returned, in the profile's own spelling.
          items:
            type: string
        certificates:
          readOnly: true
          description: Certificates of the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CertificateSchema'
        locationCountry:
          type:
          - string
          - 'null'
          description: The location country of the employee
        skillAssessmentMetadata:
          readOnly: true
          description: Metadata of the skill assessments
          allOf:
          - $ref: '#/components/schemas/SkillAssessmentMetadata'
        candidateData:
          description: candidate data of employee
          allOf:
          - $ref: '#/components/schemas/EmployeeCandidateData'
        positionCriticality:
          type:
          - array
          - 'null'
          description: The criticality of the position of the employee
          items:
            type: string
        email:
          type: string
          description: List of Emails of the employee comma seperated
        level:
          type:
          - string
          - 'null'
          description: The job level of the employee
        terminationType:
          type:
          - string
          - 'null'
          description: Termination type (voluntary / involuntary)
        employeeId:
          type: string
          description: The unique id of the Employee in the HRIS system
        employeeCriticality:
          description: The criticality information of the employee
          allOf:
          - $ref: '#/components/schemas/EmployeeCriticality'
        performanceRatings:
          description: Performance ratings for the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeePerformanceRating'
        title:
          type:
          - string
          - 'null'
          description: The title of the employee
        id:
          type:
          - string
          - 'null'
          readOnly: true
          description: Profile id of the Employee in Eightfold
        citizenship:
          type:
          - array
          - 'null'
          description: 'Citizenships of the employee, more than one when dual. A write replaces the whole list: send every citizenship that should survive it. Send [] or null to clear all. Omit the field to leave the stored citizenships untouched.'
          items:
            type: string
        preferredLastName:
          type:
          - string
          - 'null'
          description: Last name the employee goes by
        managerContactEmail:
          type:
          - string
          - 'null'
          description: The contact email of the manager
        hiringTs:
          type:
          - integer
          - 'null'
          format: int32
          description: The hiring timestamp of the employee in seconds
        projects:
          readOnly: true
          description: Projects of the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Project'
        roleChangeTs:
          type:
          - integer
          - 'null'
          format: int32
          description: The last role timestamp of the employee in seconds
        publications:
          readOnly: true
          description: Publications listed on employee profile
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Publication'
        shift:
          type:
          - string
          - 'null'
          description: Shift label (morning / evening / night / general)
        lob:
          type:
          - string
          - 'null'
          description: The lob of the employee
        skillDetails:
          readOnly: true
          description: List of profile skills with assessments
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProfileSkillSchema'
        salutation:
          type:
          - string
          - 'null'
          description: Salutation / title of address
      required:
      - email
      - employeeId
    ProjectFeedback:
      type: object
      properties:
        imageUrl:
          type:
          - string
          - 'null'
          description: Image url
        rating:
          type:
          - string
          - 'null'
          description: Rating
        name:
          type:
          - string
          - 'null'
          description: Name
        projectId:
          type:
          - integer
          - 'null'
          format: int32
          description: Project Id
        timestamp:
          type:
          - integer
          - 'null'
          format: int32
          description: Feedback Timestamp in epoch seconds
        profileId:
          type:
          - integer
          - 'null'
          format: int32
          description: Profile Id
        comment:
          type:
          - string
          - 'null'
          description: Feedback Comment
      required:
      - comment
      - imageUrl
      - name
      - profileId
      - projectId
      - rating
      - timestamp
    UserGroup:
      type: object
      properties:
        userGroupId:
          type:
          - string
          - 'null'
          format: email
          description: ''
    EmployeeSuccessionPlanLinks:
      type: object
      properties:
        comments:
          type:
          - string
          - 'null'
          description: The comments
        successionPlanId:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: Read-only. The Career Hub succession plan this employee is the incumbent of, as the numeric plan (position) id used by GET /careerhub/succession_plans/{id}, taken from the position-based plan association
        planName:
          type:
          - string
          - 'null'
          description: The name of the plan
        successors:
          description: The successors of an employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmployeeSuccessor'
        successorInPlanIds:
          type:
          - array
          - 'null'
          readOnly: true
          description: Read-only. The Career Hub succession plans this employee is an active successor in, as the numeric plan (position) ids used by GET /careerhub/succession_plans/{id}
          items:
            type: integer
            format: int32
        planDate:
          type:
          - string
          - 'null'
          description: The date of the plan
    Pay:
      type: object
      properties:
        frequency:
          type:
          - string
          - 'null'
          description: The frequency of pay
        amount:
          type:
          - number
          - 'null'
          format: float
          description: The amount of pay
        currency:
          type:
          - string
          - 'null'
          description: The currency of pay in ISO format
    ProfileSkillEvaluation:
      type: object
      properties:
        skillSubGroup:
          type:
          - string
          - 'null'
          readOnly: true
          description: The sub group within the skill group assigned to the skill. This is available only if the skill taxonomy is setup
        level:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: Normalized proficiency level on the scale of 0-1
        proficiency:
          type:
          - string
          - 'null'
          readOnly: true
          description: The display value of the assessed proficiency for the skill
        skillGroup:
          type:
          - string
          - 'null'
          readOnly: true
          description: The skill group assigned to the skill. This is availalble only if skill taxonomy is setup
        skillGroupDescription:
          type:
          - string
          - 'null'
          readOnly: true
          description: Description of the skill group. This is available only if skill taxonomy is setup
        source:
          type:
          - string
          - 'null'
          readOnly: true
          description: Indicates who made the assessment for the skill - self/manager
        skillCategoryDescription:
          type:
          - string
          - 'null'
          readOnly: true
          description: Description of the skill category. This is available only if skill taxonomy is setup
        assessmentProvider:
          type:
          - string
          - 'null'
          readOnly: true
          description: Name of the assessment provider/vendor if assessments are made in a 3rd party tool and ingested into Eightfold
        skillCategory:
          type:
          - string
          - 'null'
          readOnly: true
          description: The category of the skill group. This is available only if skill taxonomy is setup
    Source1:
      type: object
      properties:
        entityId:
          type:
          - string
          - 'null'
          description: 'The id of the entity that is attributed for gaining this skill in the external system (eg: course id for a completed course)'
        name:
          type:
          - string
          - 'null'
          description: The external system that added this skill to the profile
    BatchFetchMetaSchema:
      type: object
      properties:
        missingEntityIds:
          type:
          - array
          - 'null'
          readOnly: true
          description: List of entity ids for which no result was found
          items:
            type: string
    EmployeeCandidateData:
      type: object
      properties:
        locationCountry:
          type:
          - string
          - 'null'
          description: location country of candidate
        skills:
          type:
          - array
          - 'null'
          description: skills of candidate
          items:
            type: string
        location:
          type:
          - string
          - 'null'
          description: location of candidate
        address:
          type:
          - string
          - 'null'
          description: address of candidate
        attachments:
          description: atttachment of candidate
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsAttachmentSchema'
        education:
          description: education of candidate
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsEducationSchema'
        awards:
          writeOnly: true
          description: Awards listed on employee profile
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Award'
        customInfo:
          type:
          - object
          - 'null'
          description: custom info of candidate
        courseAttendance:
          description: course attandance of candidate
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LmsCourseAttendance'
        candidateId:
          type:
          - string
          - 'null'
          description: ATS Candidate id
        urls:
          type:
          - array
          - 'null'
          description: urls of candidate
          items:
            type: string
        tags:
          type:
          - array
          - 'null'
          description: tags of candidate
          items:
            type: string
        displayTags:
          type:
          - array
          - 'null'
          description: display tags for candidate
          items:
            type: string
        patents:
          writeOnly: true
          description: Patents listed on employee profile
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Patent'
        certifications:
          description: certification for candidate
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsCertificationSchema'
        summary:
          type:
          - string
          - 'null'
          description: summary of candidate
        photoContent:
          writeOnly: true
          description: Photo content.
          allOf:
          - $ref: '#/components/schemas/AtsContent'
        applications:
          description: applications of candidates
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsApplicationSchema'
        experience:
          description: experience of candidate
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsExperienceSchema'
        races:
          type:
          - array
          - 'null'
          description: race of candidate
          items:
            type: string
        publications:
          writeOnly: true
          description: Publications listed on employee profile
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Publication'
        dateOfBirth:
          type:
          - string
          - 'null'
          description: date of birth of candidate
        project:
          description: project of candidate
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsProjectSchema'
        gender:
          type:
          - string
          - 'null'
          description: gender of candidate
        skillDetails:
          writeOnly: true
          description: Skill proficiency data of the employee
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ATSSkillDetail'
    MatchingDemandsSchema:
      type: object
      properties:
        missingSkills:
          type:
          - array
          - 'null'
          readOnly: true
          description: Demand skills missing in resource's profile
          items:
            type: string
        skillScoreRelevance:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: Skill relevance score based on matching of demand and resource profile
        demand:
          readOnly: true
          description: Demand information in concise format
          allOf:
          - $ref: '#/components/schemas/ConciseDemandSchema'
        validatedSkills:
          type:
          - array
          - 'null'
          readOnly: true
          description: Demand skills validated in resource's profile
          items:
            type: string
        finalScore:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: The matching score (range 0 to 5) of demand and resource profile
        titleScoreRelevance:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: Title relevance score based on matching demand's hiring title with resource's experience titles
    TemporalFieldValue:
      type: object
      properties:
        endDate:
          type:
          - integer
          - 'null'
          format: int32
          description: The epoch timestamp for the end date of the temporal field value
        createTs:
          type:
          - integer
          - 'null'
          format: int32
          description: The epoch timestamp for the creation of the temporal field value
        value:
          type:
          - string
          - 'null'
          description: The value of the temporal field
        startDate:
          type: integer
          format: int32
          description: The epoch timestamp for the start date of the temporal field value
      required:
      - createTs
      - startDate
      - value
    PhotoContent:
      type: object
      properties:
        extension:
          type:
          - string
          - 'null'
          readOnly: true
          description: The extension of the photo
        content:
          type:
          - string
          - 'null'
          readOnly: true
          description: The actual string content
        isBase64:
          type:
          - boolean
          - 'null'
          readOnly: true
          description: Is the content base 64 encoded
    AdditionalManager:
      type: object
      properties:
        capacityManagerEmail:
          type:
          - string
          - 'null'
          readOnly: true
          description: The email of the capacity manager
        employeeId:
          type:
          - string
          - 'null'
          description: Employee id of the additional manager in the HRIS system
        type:
          type:
          - string
          - 'null'
          description: Type of the additional manager (e.g. capacity)
        email:
          type:
          - string
          - 'null'
          description: Email of the additional manager
    AtsAttachmentSchema:
      type: object
      properties:
        isBase64:
          type:
          - boolean
          - 'null'
          description: Denotes if the attachment base64 encoded
        fileName:
          type: string
          description: File name of the attachment
        lastModifiedTs:
          type:
          - integer
          - 'null'
          format: int32
          description: Last Modified timestamp of the attachment
        applicationMetadata:
          description: application_metadata
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsAttachmentApplicationMetadataSchema'
        attachmentContent:
          type:
          - string
          - 'null'
          description: Content of the attachment
        attachmentId:
          type: string
          description: Attachment id of the attachment
        attachmentType:
          type:
          - string
          - 'null'
          description: 'Attachment type. Valid inputs: resume, others, photo, cover_letter'
      required:
      - attachmentContent
      - attachmentId
      - attachmentType
      - fileName
    EmployeeExternalSystemId:
      type: object
      properties:
        type:
          type: string
          enum:
          - paylocity
          - greythr
          description: External system holding the id. One of ats.base.ExternalSystemType
        value:
          type:
          - string
          - 'null'
          description: Identifier of the employee in that system
      required:
      - type
    RmUserGroup:
      type: object
      properties:
        userGroupId:
          type:
          - string
          - 'null'
          description: Unique identifier for the user group
    EmployeeAssociatedRole:
      type: object
      properties:
        roleVariantId:
          type:
          - string
          - 'null'
          readOnly: true
          description: The id of the role variant of the employee
        roleVariantName:
          type:
          - string
          - 'null'
          readOnly: true
          description: The name of the role variant of the employee
        updateAt:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: The timestamp of the employee associated role data update
        primaryRoleId:
          type:
          - string
          - 'null'
          readOnly: true
          description: The id of primary role of the employee
        externalVariantId:
          type:
          - string
          - 'null'
          readOnly: true
          description: The external identifier for the role variant
        primaryRoleName:
          type:
          - string
          - 'null'
          readOnly: true
          description: The name of primary role of the employee
    ATSScoreCardAttribute:
      type: object
      properties:
        rating:
          type:
          - string
          - 'null'
          description: 'Rating. Valid inputs: strong_yes, yes, mixed, no, strong_no'
        answer:
          type:
          - string
          - 'null'
          description: Answer
        note:
          type:
          - string
          - 'null'
          description: Note
        question:
          type:
          - string
          - 'null'
          description: Question
        rating_label:
          type:
          - string
          - 'null'
          description: Rating label
    MatchingPositionsSchema:
      type: object
      properties:
        missingSkills:
          type:
          - array
          - 'null'
          readOnly: true
          description: Position skills missing in candidate's profile
          items:
            type: string
        position:
          readOnly: true
          description: Position information in concise format
          allOf:
          - $ref: '#/components/schemas/ConcisePositionSchema'
        skillScoreRelevance:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: Skill relevance score based on matching of job and candidate profile
        validatedSkills:
          type:
          - array
          - 'null'
          readOnly: true
          description: Position skills validated in candidate's profile
          items:
            type: string
        finalScore:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: The matching score (range 0 to 5) of job and candidate profile
        titleScoreRelevance:
          type:
          - number
          - 'null'
          format: float
          readOnly: true
          description: Title relevance score based on matching of job and candidate profile
    EmployeeSuccessor:
      type: object
      properties:
        employeeDetails:
          description: The employee details
          allOf:
          - $ref: '#/components/schemas/User'
        readiness:
          type:
          - string
          - 'null'
          description: The readiness of the successor
        rank:
          type:
          - integer
          - 'null'
          format: int32
          description: The rank
        comments:
          type:
          - string
          - 'null'
          description: The comments
    AtsStage:
      type: object
      properties:
        stage:
          type:
          - string
          - 'null'
          readOnly: true
          description: stage
        user:
          description: user
          allOf:
          - $ref: '#/components/schemas/AtsUser'
        reason:
          type: string
          maxLength: 5000
          description: reason
        wfSubStage:
          type: string
          description: wf sub stage
        wfStage:
          type: string
          description: wf stage
        stageTs:
          type: integer
          format: int32
          description: stage timestamp
      required:
      - reason
      - stageTs
      - user
      - wfStage
      - wfSubStage
    Award:
      type: object
      properties:
        entity:
          type:
          - string
          - 'null'
          description: award entity
        date:
          type: string
          description: date for award
        allText:
          type:
          - string
          - 'null'
          description: all text data for award
        skills:
          type:
          - array
          - 'null'
          description: Award skills
          items:
            type: string
        description:
          type:
          - string
          - 'null'
          description: description for award
        title:
          type: string
          description: award title
      required:
      - date
      - title
    ExperienceSchema:
      type: object
      properties:
        industry:
          type:
          - string
          - 'null'
          description: industry of the candidate/organization
        endTime:
          type:
          - integer
          - 'null'
          format: int32
          description: End time of employee in an organization
        durationMonths:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: Duration of work experience in months
        isInternal:
          type:
          - boolean
          - 'null'
          description: is internal for candidate
        addlJson:
          type:
          - object
          - 'null'
          description: Additional json data
        department:
          type:
          - string
          - 'null'
          description: Department of the candidate
        work:
          type:
          - string
          - 'null'
          description: Organization or Company of work
        userVerifiedSkills:
          type:
          - boolean
          - 'null'
          description: any verified skills
        experienceKey:
          type:
          - string
          - 'null'
          description: Unique key for each experience
        skills:
          type: array
          description: Skills invovled
          items:
            type: string
        location:
          type:
          - string
          - 'null'
          description: Location of the organization
        startTime:
          type:
          - integer
          - 'null'
          format: int32
          description: Start time of employee in an organization
        edited:
          type:
          - boolean
          - 'null'
          description: is edited candidate?
        isCurrent:
          type:
          - boolean
          - 'null'
          description: Currently working in an organization
        description:
          type:
          - string
          - 'null'
          description: Description of work
        title:
          type:
          - string
          - 'null'
          description: Title of work experience
      required:
      - description
      - edited
      - endTime
      - isCurrent
      - isInternal
      - location
      - startTime
      - title
      - work
    ProfileAsyncSchema:
      type: object
      properties:
        transactionId:
          type:
          - string
          - 'null'
          readOnly: true
          description: ''
    AtsUser:
      type: object
      properties:
        userId:
          type:
          - string
          - 'null'
          description: user id
        email:
          type:
          - string
          - 'null'
          description: email of user
        name:
          type:
          - string
          - 'null'
          description: name of user
        atsRoles:
          type:
          - array
          - 'null'
          description: list of ats roles
          items:
            type: string
    AtsApplicationSchema:
      type: object
      properties:
        locationCountry:
          type:
          - string
          - 'null'
          description: location country of an application
        reason:
          type:
          - string
          - 'null'
          maxLength: 5000
          description: reason for an application
        location:
          type:
          - string
          - 'null'
          description: location of an application
        visaStatuses:
          type:
          - array
          - 'null'
          description: list of visa status
          items:
            type: string
        veteranStatusStr:
          type:
          - string
          - 'null'
          readOnly: true
          description: String value for veteran status of the applicant
        jobs:
          description: Jobs related to an application.
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Jobs'
        hiredTs:
          type:
          - integer
          - 'null'
          format: int32
          description: hired timestamp of an applicant
        lastModifiedTs:
          type:
          - integer
          - 'null'
          format: int32
          description: last modified timestamp of an application
        customInfo:
          type:
          - object
          - 'null'
          description: custom info for an application
        note:
          description: ats notes for an application
          allOf:
          - $ref: '#/components/schemas/AtsNoteSchema'
        systemId:
          type:
          - string
          - 'null'
          description: system id of an application
        creditor:
          type:
          - string
          - 'null'
          description: creditor of an application
        candidateId:
          type:
          - string
          - 'null'
          description: candidate id of an applicant
        rejectedTs:
          type:
          - integer
          - 'null'
          format: int32
          description: rejected timestamp of an applicant
        veteranStatus:
          type:
          - boolean
          - 'null'
          description: Boolean value for veteran status of the applicant
        applicationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: application timestamp
        pastStages:
          description: past stages of an application
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsStage'
        sourceName:
          type:
          - string
          - 'null'
          description: source name of an application
        isProspect:
          type:
          - boolean
          - 'null'
          description: is prospective applicant
        scorecards:
          description: scorecards for an application
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsScorecard'
        jobSystemId:
          type:
          - string
          - 'null'
          description: job system id for an application
        disabilityStatus:
          type:
          - boolean
          - 'null'
          description: disability status of an applicant
        currentStage:
          description: current stage of an application
          allOf:
          - $ref: '#/components/schemas/AtsStage'
        status:
          type:
          - string
          - 'null'
          description: 'Status of application.Valid inputs: active, hired, rejected, converted, withdrawn'
        races:
          type:
          - array
          - 'null'
          description: list of races of an applicant
          items:
            type: string
        sourceType:
          type:
          - string
          - 'null'
          description: source type of an application
        gender:
          type:
          - string
          - 'null'
          description: gender of an applicant
        questions:
          description: questions
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AtsQuestionAnswer'
        rejectedBy:
          type:
          - string
          - 'null'
          description: applicant rejected by
        disabilityStatusStr:
          type:
          - string
          - 'null'
          readOnly: true
          description: disability status of an applicant
        applicationId:
          type: string
          description: application id
      required:
      - applicationId
      - applicationTs
      - candidateId
      - lastModifiedTs
    LmsCourseAttendance:
      type: object
      properties:
        durationHours:
          type:
          - number
          - 'null'
          format: float
          description: Duration of the course (in hours)
        percentageCompletion:
          type:
          - number
          - 'null'
          format: float
          description: Percentage Completion
        isInternal:
          type:
          - boolean
          - 'null'
          description: Is Internal
        pointsEarned:
          type:
          - number
          - 'null'
          format: float
          description: Points Earned
        courseType:
          type:
          - string
          - 'null'
          description: Course type
        difficulty:
          type:
          - string
          - 'null'
          description: difficulty
        courseUrl:
          type:
          - string
          - 'null'
          description: Course Url
        title:
          type:
          - string
          - 'null'
          description: 'Title. Note: Course Id or title must be present.'
        completionTs:
          type:
          - integer
          - 'null'
          format: int32
          description: Completion Timestamp
        lmsCourseId:
          type:
          - string
          - 'null'
          description: 'LMS Course Id. Note: Course Id or title must be present.'
        medium:
          type:
          - string
          - 'null'
          description: medium
        language:
          type:
          - string
          - 'null'
          description: Language
        dueTs:
          type:
          - integer
          - 'null'
          format: int32
          description: Due Timestamp
        assignedBy:
          type:
          - string
          - 'null'
          description: Email of who assigned this course
        status:
          type:
          - string
          - 'null'
          description: status
        startTs:
          type:
          - integer
          - 'null'
          format: int32
          description: Start timestamp
        isMandatory:
          type:
          - boolean
          - 'null'
          description: is course attendance mandatory ?
        provider:
          type:
          - string
          - 'null'
          description: provider
        verified:
          type:
          - string
          - 'null'
          description: verified
        description:
          type:
          - string
          - 'null'
          description: description
    EmployeeLanguageProficiency:
      type: object
      properties:
        read:
          type:
          - string
          - 'null'
          description: The reading proficiency
        speak:
          type:
          - string
          - 'null'
          description: The speaking proficiency
        overall:
          type:
          - string
          - 'null'
          description: The overall proficiency
        language:
          type:
          - string
          - 'null'
          description: The language string
        write:
          type:
          - string
          - 'null'
          description: The writing proficiency
    Jobs:
      type: object
      properties:
        atsJobId:
          type:
          - string
          - 'null'
          description: ATS Job id
        name:
          type:
          - string
          - 'null'
          description: Name
    User:
      type: object
      properties:
        atsUserGroups:
          description: The user groups
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UserGroup'
        name:
          type:
          - string
          - 'null'
          description: The name of the user
        atsRoles:
          type:
          - array
          - 'null'
          description: The ats roles
          items:
            type: string
        userId:
          type:
          - string
          - 'null'
          description: The user id of the user
        firstName:
          type:
          - string
          - 'null'
          description: The first name of the user
        lastName:
          type:
          - string
          - 'null'
          description: The last name of the user
        email:
          type:
          - string
          - 'null'
          format: email
          description: The email of the user
    RecommendedMentorSchema:
      type: object
      properties:
        businessUnit:
          type:
          - string
          - 'null'
          readOnly: true
          description: Business unit of the employee
        name:
          type:
          - string
          - 'null'
          readOnly: true
          description: Full name of the employee
        profileId:
          type:
          - string
          - 'null'
          readOnly: true
          description: Encoded employee profile ID in Eightfold Career Hub
        location:
          type:
          - string
          - 'null'
          readOnly: true
          description: Location of the employee
        email:
          type:
          - string
          - 'null'
          format: email
          readOnly: true
          description: Email address of the employee
        title:
          type:
          - string
          - 'null'
          readOnly: true
          description: Title of the employee
    EmployeeBadge:
      type: object
      properties:
        badgeId:
          type:
          - string
          - 'null'
          description: The id of the badge
        userId:
          type:
          - string
          - 'null'
          description: The user id the badge belongs to.
        creator:
          type:
          - string
          - 'null'
          description: The creator of the badge
        photoUrl:
          type:
          - string
          - 'null'
          description: The photo url
        lastModifiedTs:
          type:
          - integer
          - 'null'
          format: int32
          description: The last modified timestamp of the badge
        photoContent:
          description: The photo content
          allOf:
          - $ref: '#/components/schemas/PhotoContent'
        comment:
          type:
          - string
          - 'null'
          description: comment on the badge
        title:
          type:
          - string
          - 'null'
          description: The title of the badge
    EmployeeMobility:
      type: object
      properties:
        comments:
          type:
          - string
          - 'null'
          description: The comments
        travelPercentageMin:
          type:
          - number
          - 'null'
          format: float
          description: The min travel percentage
        relocationLocations:
          type:
          - array
          - 'null'
          description: The relocation locations
          items:
            type: string
        relocation:
          type:
          - string
          - 'null'
          description: The relocation information
        travel:
          type:
          - string
          - 'null'
          description: The travel detail
        travelPercentageMax:
          type:
          - number
          - 'null'
          format: float
          description: The max travel percentage
    ConcisePositionSchema:
      type: object
      properties:
        postingUrl:
          type:
          - string
          - 'null'
          readOnly: true
          description: posting Url
        atsEntityId:
          type:
          - string
          - 'null'
          readOnly: true
          description: atsEntityId in the ats system
        locations:
          type:
          - array
          - 'null'
          readOnly: true
          description: The name of the location of the job
          items:
            type: string
        positionId:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: job id
        title:
          type:
          - string
          - 'null'
          readOnly: true
          description: The job title
    ConciseDemandSchema:
      type: object
      properties:
        demandId:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: Demand ID
        extDemandId:
          type:
          - string
          - 'null'
          readOnly: true
          description: External demand ID in the ATS system
        name:
          type:
          - string
          - 'null'
          readOnly: true
          description: Title of the demand
        locations:
          type:
          - array
          - 'null'
          readOnly: true
          description: The location(s) of the demand
          items:
            type: string
    EmployeeCriticality:
      type: object
      properties:
        riskOfLoss:
          type:
          - string
          - 'null'
          description: The risk of looking the employee
        impactOfLoss:
          type:
          - string
          - 'null'
          description: The impact of loss of the employee
    AtsEducationSchema:
      type: object
      properties:
        endTs:
          type:
          - integer
          - 'null'
          format: int32
          description: ending timestamp
        verificationStatus:
          type:
          - string
          - 'null'
          description: verification status of the education details
        degreeExternalId:
          type:
          - string
          - 'null'
          description: external id of the degree
        attachmentIds:
          type:
          - array
          - 'null'
          description: List of attachment ids of the education
          items:
            type: string
        startTs:
          type:
          - integer
          - 'null'
          format: int32
          description: starting timestamp of education
        degree:
          type:
          - string
          - 'null'
          description: degree
        major:
          type:
          - string
          - 'null'
          description: major
        verificationBy:
          type:
          - string
          - 'null'
          description: email of the verifier
        location:
          type:
          - string
          - 'null'
          description: location
        isCurrent:
          type:
          - boolean
          - 'null'
          description: is current education
        schoolExternalId:
          type:
          - string
          - 'null'
          description: external id of the school
        majorExternalId:
          type:
          - string
          - 'null'
          description: external id of the major
        verificationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: verification timestamp
        school:
          type:
          - string
          - 'null'
          description: school
        nameAlias:
          type:
          - string
          - 'null'
          description: name of the candidate in the records if different from the name in the profile
        isGraduated:
          type:
          - boolean
          - 'null'
          description: graduation status of the candidate
        description:
          type:
          - string
          - 'null'
          description: description
      required:
      - degree
      - description
      - location
      - major
      - school
      - startTs
    Patent:
      type: object
      properties:
        date:
          type: string
          description: Patent date
        allText:
          type:
          - string
          - 'null'
          description: Patent title
        skills:
          type:
          - array
          - 'null'
          description: Patent skills
          items:
            type: string
        description:
          type:
          - string
          - 'null'
          description: Patent description
        title:
          type: string
          description: Patent title
      required:
      - date
      - title
    MetaSchema:
      type: object
      properties:
        totalCount:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: ''
        pageTotalCount:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: ''
        pageStartIndex:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
          description: ''
    Project:
      type: object
      properties:
        addlJson:
          type:
          - object
          - 'null'
          readOnly: true
          description: Additional Json Data
        projectId:
          type: string
          description: Project projectid
        duration:
          type: integer
          format: int32
          description: Project duration in months
        links:
          type:
          - array
          - 'null'
          description: Project links
          items:
            type: string
        personal_description:
          type:
          - string
          - 'null'
          description: Project personal description
        skills:
          type: array
          description: Project skills
          items:
            type: string
        time:
          type: string
          description: Project time
        feedback:
          description: Project feedback
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProjectFeedback'
        company:
          type:
          - string
          - 'null'
          description: Project company
        contributors:
          type:
          - array
          - 'null'
          description: Project contributors
          items:
            type: string
        description:
          type:
          - string
          - 'null'
          description: Project description
        title:
          type: string
          description: Project title
      required:
      - company
      - contributors
      - duration
      - projectId
      - skills
      - time
      - title
    Publication:
      type: object
      properties:
        date:
          type:
          - string
          - 'null'
          description: Patent date
        skills:
          type:
          - array
          - 'null'
          description: Publication skills
          items:
            type: string
        publisher:
          type:
          - string
          - 'null'
          description: Patent publisher
        description:
          type: string
          description: Patent description
        title:
          type:
          - string
          - 'null'
          description: Patent title
      required:
      - description
    ATSSkillDetail:
      type: object
      properties:
        skillGroups:
          description: Skill groups
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ATSSkillGroup'
        proficiency:
          type:
          - string
          - 'null'
          description: 'Proficiency. Note: proficiency must be specified only for each skill group when skill groups are present'
        evaluationTimestamp:
          type:
          - integer
          - 'null'
          format: int32
          description: Evaluation timestamp
        dataSource:
          type:
          - string
          - 'null'
          description: Data source of the skill
        skill:
          type:
          - string
          - 'null'
          description: Skill
    CandidateEducation:
      type: object
      properties:
        verificationStatus:
          type:
          - string
          - 'null'
          description: verification status of the education details
        location:
          type:
          - string
          - 'null'
          description: Location of Candidate Education
        school:
          type:
          - string
          - 'null'
          description: School of candidate
        isCurrent:
          type:
          - boolean
          - 'null'
          description: Currently working in an organization
        isGraduated:
          type:
          - boolean
          - 'null'
          description: graduation status of the candidate
        endTime:
          type:
          - integer
          - 'null'
          format: int32
          description: end time of candidate
        awards:
          type:
          - array
          - 'null'
          description: Awards of candidate
          items:
            type: string
        source:
          type:
          - string
          - 'null'
          readOnly: true
          description: source
        degree:
          type:
          - string
          - 'null'
          description: Degree of candidate
        startTime:
          type:
          - integer
          - 'null'
          format: int32
          description: start time of candidate
        verificationBy:
          type:
          - string
          - 'null'
          description: email of the verifier
        major:
          type:
          - string
          - 'null'
          description: major of candidate
        majorExternalId:
          type:
          - string
          - 'null'
          description: external id of the major
        verificationTs:
          type:
          - integer
          - 'null'
          format: int32
          description: verification timestamp
        degreeExternalId:
          type:
          - string
          - 'null'
          description: external id of the degree
        attachmentIds:
          type:
          - array
          - 'null'
          description: List of attachment ids of the education
          items:
            type: string
        schoolExternalId:
          type:
          - string
          - 'null'
          description: external id of the school
        nameAlias:
          type:
          - string
          - 'null'
          description: name of the candidate in the records if different from the name in the profile
        description:
          type:
          - string
          - 'null'
          description: Description of candidate
      required:
      - degree
      - description
      - endTime
      - location
      - major
      - school
      - startTime
x-provenance:
  method: searched
  source: https://apidocs.eightfold.ai/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://apidocs.eightfold.ai/reference/booking_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/comments_entity__batch_fetch.md
  - https://apidocs.eightfold.ai/reference/comments_ext_entity__batch_fetch.md
  - https://apidocs.eightfold.ai/reference/create_approval_workflow.md
  - https://apidocs.eightfold.ai/reference/create_ats_candidate.md
  - https://apidocs.eightfold.ai/reference/create_ats_position.md
  - https://apidocs.eightfold.ai/reference/create_ats_position_attachments.md
  - https://apidocs.eightfold.ai/reference/create_booking.md
  - https://apidocs.eightfold.ai/reference/create_careerhub_provide.md
  - https://apidocs.eightfold.ai/reference/create_careerhub_request.md
  - https://apidocs.eightfold.ai/reference/create_careerhub_upskill_plan_assignment.md
  - https://apidocs.eightfold.ai/reference/create_comments_entity_comments.md
  - https://apidocs.eightfold.ai/reference/create_comments_ext_entity_comments.md
  - https://apidocs.eightfold.ai/reference/create_course.md
  - https://apidocs.eightfold.ai/reference/create_demand.md
  - https://apidocs.eightfold.ai/reference/create_employee.md
  - https://apidocs.eightfold.ai/reference/create_employee_role.md
  - https://apidocs.eightfold.ai/reference/create_ext_ai_interview_schedule_interview.md
  - https://apidocs.eightfold.ai/reference/create_external_booking_ext_bookings.md
  - https://apidocs.eightfold.ai/reference/create_external_demand_employee_create_or_advance_application_stage.md
  - https://apidocs.eightfold.ai/reference/create_external_demand_ext_demands.md
  - https://apidocs.eightfold.ai/reference/create_external_demand_org_unit_ext_demand_org_units.md
  - https://apidocs.eightfold.ai/reference/create_foundational_data.md
  - https://apidocs.eightfold.ai/reference/create_holiday.md
  - https://apidocs.eightfold.ai/reference/create_insights_talent_traits.md
  - https://apidocs.eightfold.ai/reference/create_jie_roles.md
  - https://apidocs.eightfold.ai/reference/create_offer.md
  - https://apidocs.eightfold.ai/reference/create_position.md
  - https://apidocs.eightfold.ai/reference/create_profile.md
  - https://apidocs.eightfold.ai/reference/create_profile_cancel_scheduled_rejection.md
  - https://apidocs.eightfold.ai/reference/create_profile_note.md
  - https://apidocs.eightfold.ai/reference/create_profile_stages.md
  - https://apidocs.eightfold.ai/reference/create_profile_tag.md
  - https://apidocs.eightfold.ai/reference/create_profile_unsubscribe.md
  - https://apidocs.eightfold.ai/reference/create_succession_plan.md
  - https://apidocs.eightfold.ai/reference/create_succession_plan_caretakers.md
  - https://apidocs.eightfold.ai/reference/create_succession_plan_successors.md
  - https://apidocs.eightfold.ai/reference/create_talent_pool.md
  - https://apidocs.eightfold.ai/reference/create_upskill_plan_template.md
  - https://apidocs.eightfold.ai/reference/create_user_group.md
  - https://apidocs.eightfold.ai/reference/create_user_group_users.md
  - https://apidocs.eightfold.ai/reference/create_user_login_users.md
  - https://apidocs.eightfold.ai/reference/delete_booking.md
  - https://apidocs.eightfold.ai/reference/delete_careerhub_ext.md
  - https://apidocs.eightfold.ai/reference/delete_careerhub_upskill_plan_assignment.md
  - https://apidocs.eightfold.ai/reference/delete_comments_entity_comments.md
  - https://apidocs.eightfold.ai/reference/delete_course.md
  - https://apidocs.eightfold.ai/reference/delete_demand.md
  - https://apidocs.eightfold.ai/reference/delete_external_booking_ext_bookings.md
  - https://apidocs.eightfold.ai/reference/delete_external_demand_ext_demands.md
  - https://apidocs.eightfold.ai/reference/delete_holiday.md
  - https://apidocs.eightfold.ai/reference/delete_jie_roles.md
  - https://apidocs.eightfold.ai/reference/delete_offer.md
  - https://apidocs.eightfold.ai/reference/delete_profile.md
  - https://apidocs.eightfold.ai/reference/delete_succession_plan.md
  - https://apidocs.eightfold.ai/reference/delete_succession_plan_caretakers.md
  - https://apidocs.eightfold.ai/reference/delete_succession_plan_successors.md
  - https://apidocs.eightfold.ai/reference/delete_upskill_plan_template.md
  - https://apidocs.eightfold.ai/reference/delete_upskill_plan_template_ext.md
  - https://apidocs.eightfold.ai/reference/delete_user_group.md
  - https://apidocs.eightfold.ai/reference/delete_user_group_users.md
  - https://apidocs.eightfold.ai/reference/delete_user_login_users.md
  - https://apidocs.eightfold.ai/reference/demand_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/email_delivery_feedback_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/employee_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/entity_profile_application_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/event_candidate_activity_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/events_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/get_approval_workflow_by_id.md
  - https://apidocs.eightfold.ai/reference/get_async_api_status_transactions_by_id.md
  - https://apidocs.eightfold.ai/reference/get_ats_candidate_by_id.md
  - https://apidocs.eightfold.ai/reference/get_ats_position_by_id.md
  - https://apidocs.eightfold.ai/reference/get_booking_by_id.md
  - https://apidocs.eightfold.ai/reference/get_career_navigator_recommended_paths_by_id.md
  - https://apidocs.eightfold.ai/reference/get_careerhub_ext_by_id.md
  - https://apidocs.eightfold.ai/reference/get_careerhub_performance_feedback_by_id.md
  - https://apidocs.eightfold.ai/reference/get_careerhub_suggest_skills_by_id.md
  - https://apidocs.eightfold.ai/reference/get_careerhub_upskill_plan_assignment_by_id.md
  - https://apidocs.eightfold.ai/reference/get_comments_comments_by_id.md
  - https://apidocs.eightfold.ai/reference/get_course_by_id.md
  - https://apidocs.eightfold.ai/reference/get_demand_by_id.md
  - https://apidocs.eightfold.ai/reference/get_email_delivery_feedback_by_id.md
  - https://apidocs.eightfold.ai/reference/get_employee_by_id.md
  - https://apidocs.eightfold.ai/reference/get_employee_role_by_id.md
  - https://apidocs.eightfold.ai/reference/get_entity_profile_application_by_id.md
  - https://apidocs.eightfold.ai/reference/get_event_candidate_activity_by_id.md
  - https://apidocs.eightfold.ai/reference/get_events_planned_events_by_id.md
  - https://apidocs.eightfold.ai/reference/get_external_booking_ext_bookings_by_id.md
  - https://apidocs.eightfold.ai/reference/get_external_demand_ext_demands_by_id.md
  - https://apidocs.eightfold.ai/reference/get_external_demand_org_unit_ext_demand_org_units_by_id.md
  - https://apidocs.eightfold.ai/reference/get_foundational_data_by_id.md
  - https://apidocs.eightfold.ai/reference/get_holiday_by_id.md
  - https://apidocs.eightfold.ai/reference/get_hris_employee_hris_employees_by_id.md
  - https://apidocs.eightfold.ai/reference/get_jie_roles_by_id.md
  - https://apidocs.eightfold.ai/reference/get_offer_by_id.md
  - https://apidocs.eightfold.ai/reference/get_position_apply_form_questions_by_id.md
  - https://apidocs.eightfold.ai/reference/get_position_by_id.md
  - https://apidocs.eightfold.ai/reference/get_profile_application_by_id.md
  - https://apidocs.eightfold.ai/reference/get_profile_attachments_by_id.md
  - https://apidocs.eightfold.ai/reference/get_profile_by_id.md
  - https://apidocs.eightfold.ai/reference/get_profile_feedback_by_id.md
  - https://apidocs.eightfold.ai/reference/get_profile_note_by_id.md
  - https://apidocs.eightfold.ai/reference/get_profile_tag_by_id.md
  - https://apidocs.eightfold.ai/reference/get_question_template_by_id.md
  - https://apidocs.eightfold.ai/reference/get_succession_plan_by_id.md
  - https://apidocs.eightfold.ai/reference/get_upskill_plan_template_by_id.md
  - https://apidocs.eightfold.ai/reference/get_upskill_plan_template_ext_by_id.md
  - https://apidocs.eightfold.ai/reference/get_user_calendar_event_by_id.md
  - https://apidocs.eightfold.ai/reference/get_user_campaign_by_id.md
  - https://apidocs.eightfold.ai/reference/get_user_group_by_id.md
  - https://apidocs.eightfold.ai/reference/get_user_login_users_by_id.md
  - https://apidocs.eightfold.ai/reference/get_user_message_by_id.md
  - https://apidocs.eightfold.ai/reference/get_workforce_exchange_hiring_company_hiring_company_by_id.md
  - https://apidocs.eightfold.ai/reference/holiday_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/list_ats_candidate.md
  - https://apidocs.eightfold.ai/reference/list_ats_position.md
  - https://apidocs.eightfold.ai/reference/list_booking.md
  - https://apidocs.eightfold.ai/reference/list_career_navigator_recommended_courses.md
  - https://apidocs.eightfold.ai/reference/list_careerhub_performance_feedback.md
  - https://apidocs.eightfold.ai/reference/list_careerhub_recommended_courses.md
  - https://apidocs.eightfold.ai/reference/list_careerhub_roles.md
  - https://apidocs.eightfold.ai/reference/list_careerhub_skill_gap_analysis.md
  - https://apidocs.eightfold.ai/reference/list_careerhub_upskill_plan_assignment.md
  - https://apidocs.eightfold.ai/reference/list_comments_comments.md
  - https://apidocs.eightfold.ai/reference/list_comments_entity_comments.md
  - https://apidocs.eightfold.ai/reference/list_comments_ext_entity_comments.md
  - https://apidocs.eightfold.ai/reference/list_course.md
  - https://apidocs.eightfold.ai/reference/list_demand.md
  - https://apidocs.eightfold.ai/reference/list_email_delivery_feedback.md
  - https://apidocs.eightfold.ai/reference/list_employee.md
  - https://apidocs.eightfold.ai/reference/list_employee_matched_demands.md
  - https://apidocs.eightfold.ai/reference/list_employee_matched_positions.md
  - https://apidocs.eightfold.ai/reference/list_employee_recommended_mentors.md
  - https://apidocs.eightfold.ai/reference/list_employee_role_match_score.md
  - https://apidocs.eightfold.ai/reference/list_entity_changelog_changelog.md
  - https://apidocs.eightfold.ai/reference/list_entity_profile_application.md
  - https://apidocs.eightfold.ai/reference/list_event_candidate_activity.md
  - https://apidocs.eightfold.ai/reference/list_events_planned_events.md
  - https://apidocs.eightfold.ai/reference/list_ext_ai_interview_guides.md
  - https://apidocs.eightfold.ai/reference/list_ext_ai_interview_interview_feedback_link.md
  - https://apidocs.eightfold.ai/reference/list_external_demand_ext_demands.md
  - https://apidocs.eightfold.ai/reference/list_foundational_data.md
  - https://apidocs.eightfold.ai/reference/list_holiday.md
  - https://apidocs.eightfold.ai/reference/list_hris_employee_hris_employees.md
  - https://apidocs.eightfold.ai/reference/list_insights_employees.md
  - https://apidocs.eightfold.ai/reference/list_insights_profile_insights.md
  - https://apidocs.eightfold.ai/reference/list_jie_insights.md
  - https://apidocs.eightfold.ai/reference/list_jie_roles.md
  - https://apidocs.eightfold.ai/reference/list_offer.md
  - https://apidocs.eightfold.ai/reference/list_org_unit.md
  - https://apidocs.eightfold.ai/reference/list_position.md
  - https://apidocs.eightfold.ai/reference/list_position_matched.md
  - https://apidocs.eightfold.ai/reference/list_profile.md
  - https://apidocs.eightfold.ai/reference/list_profile_applicants.md
  - https://apidocs.eightfold.ai/reference/list_profile_application.md
  - https://apidocs.eightfold.ai/reference/list_profile_feedback.md
  - https://apidocs.eightfold.ai/reference/list_profile_matched_candidates.md
  - https://apidocs.eightfold.ai/reference/list_profile_note.md
  - https://apidocs.eightfold.ai/reference/list_profile_tag.md
  - https://apidocs.eightfold.ai/reference/list_question_options.md
  - https://apidocs.eightfold.ai/reference/list_succession_plan.md
  - https://apidocs.eightfold.ai/reference/list_succession_plan_incumbents.md
  - https://apidocs.eightfold.ai/reference/list_succession_plan_recommended_successors.md
  - https://apidocs.eightfold.ai/reference/list_upskill_plan_template.md
  - https://apidocs.eightfold.ai/reference/list_user_calendar_event.md
  - https://apidocs.eightfold.ai/reference/list_user_campaign.md
  - https://apidocs.eightfold.ai/reference/list_user_group.md
  - https://apidocs.eightfold.ai/reference/list_user_group_users.md
  - https://apidocs.eightfold.ai/reference/list_user_login_users.md
  - https://apidocs.eightfold.ai/reference/list_user_message.md
  - https://apidocs.eightfold.ai/reference/patch_ats_candidate.md
  - https://apidocs.eightfold.ai/reference/patch_ats_position.md
  - https://apidocs.eightfold.ai/reference/patch_booking.md
  - https://apidocs.eightfold.ai/reference/patch_careerhub_.md
  - https://apidocs.eightfold.ai/reference/patch_careerhub_ext.md
  - https://apidocs.eightfold.ai/reference/patch_careerhub_upskill_plan_assignment.md
  - https://apidocs.eightfold.ai/reference/patch_course.md
  - https://apidocs.eightfold.ai/reference/patch_demand.md
  - https://apidocs.eightfold.ai/reference/patch_employee.md
  - https://apidocs.eightfold.ai/reference/patch_external_booking_ext_bookings.md
  - https://apidocs.eightfold.ai/reference/patch_external_demand_ext_demands.md
  - https://apidocs.eightfold.ai/reference/patch_external_demand_org_unit_ext_demand_org_units.md
  - https://apidocs.eightfold.ai/reference/patch_foundational_data.md
  - https://apidocs.eightfold.ai/reference/patch_holiday.md
  - https://apidocs.eightfold.ai/reference/patch_hris_employee_ext_employees.md
  - https://apidocs.eightfold.ai/reference/patch_offer.md
  - https://apidocs.eightfold.ai/reference/patch_offer_ats_positions.md
  - https://apidocs.eightfold.ai/reference/patch_position.md
  - https://apidocs.eightfold.ai/reference/patch_profile.md
  - https://apidocs.eightfold.ai/reference/patch_succession_plan.md
  - https://apidocs.eightfold.ai/reference/patch_succession_plan_successors.md
  - https://apidocs.eightfold.ai/reference/patch_upskill_plan_template.md
  - https://apidocs.eightfold.ai/reference/patch_upskill_plan_template_ext.md
  - https://apidocs.eightfold.ai/reference/patch_user_group.md
  - https://apidocs.eightfold.ai/reference/patch_user_login_users.md
  - https://apidocs.eightfold.ai/reference/patch_workforce_exchange_hiring_company_hiring_company.md
  - https://apidocs.eightfold.ai/reference/position_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/profile_application_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/profile_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/profile_feedback_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/profile_note_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/profile_tag_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/update_ats_candidate.md
  - https://apidocs.eightfold.ai/reference/update_ats_position.md
  - https://apidocs.eightfold.ai/reference/update_booking.md
  - https://apidocs.eightfold.ai/reference/update_demand.md
  - https://apidocs.eightfold.ai/reference/update_employee.md
  - https://apidocs.eightfold.ai/reference/update_external_booking_ext_bookings.md
  - https://apidocs.eightfold.ai/reference/update_external_demand_ext_demands.md
  - https://apidocs.eightfold.ai/reference/update_holiday.md
  - https://apidocs.eightfold.ai/reference/update_hris_employee_ext_employees.md
  - https://apidocs.eightfold.ai/reference/update_jie_roles.md
  - https://apidocs.eightfold.ai/reference/update_position.md
  - https://apidocs.eightfold.ai/reference/update_profile.md
  - https://apidocs.eightfold.ai/reference/user_calendar_event_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/user_campaign_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/user_login_batch_fetch.md
  - https://apidocs.eightfold.ai/reference/user_message_batch_fetch.md
  merge:
    pages: 218
    deduped: 2038
    conflicts_kept_first: 0