> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toku.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Hris Change Requests

> Lists change requests, optionally merged with time-off, with filters, sorting, pagination and pending count.

Required scope: `people:read`. It also needs `banking:read`, `compensation:read`, `identity:read`, `time:read`.

## OpenAPI

````yaml api-reference/openapi.json POST /hris/get-hris-change-requests
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/get-hris-change-requests:
    post:
      operationId: getHrisChangeRequests
      summary: Get Hris Change Requests
      x-toku-required-scope: people:read
      description: >-
        Lists change requests, optionally merged with time-off, with filters,
        sorting, pagination and pending count.


        Required scope: `people:read`. It also needs `banking:read`,
        `compensation:read`, `identity:read`, `time:read`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetHrisChangeRequestsRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHrisChangeRequestsResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetHrisChangeRequestsRequest:
      type: object
      properties:
        status:
          type: string
          enum:
            - PENDING
            - APPROVED
            - REJECTED
            - CANCELLED
            - AUTO_APPROVED
        category:
          type: string
          enum:
            - NEW_HIRE
            - PERSONAL_INFO
            - BUSINESS_ENTITY
            - EMERGENCY_CONTACT
            - COMPENSATION
            - EMPLOYMENT
            - TAX_INFO
            - TERMINATION
            - EMPLOYMENT_TYPE
            - WORK_AUTH
            - WALLET
            - BENEFITS_NETWORK
            - ADDITIONAL_COMPENSATION
            - STABLECOIN_ALLOCATION
            - PROVIDENT_FUND
        search:
          type: string
          maxLength: 200
          description: >-
            NOTE(ck): a .transform() rule is not mirrored here; TGA still
            enforces it
        statuses:
          type: array
          items:
            oneOf:
              - type: string
                enum:
                  - PENDING
                  - APPROVED
                  - REJECTED
                  - CANCELLED
                  - AUTO_APPROVED
              - const: SCHEDULED
        categories:
          type: array
          items:
            oneOf:
              - type: string
                enum:
                  - NEW_HIRE
                  - PERSONAL_INFO
                  - BUSINESS_ENTITY
                  - EMERGENCY_CONTACT
                  - COMPENSATION
                  - EMPLOYMENT
                  - TAX_INFO
                  - TERMINATION
                  - EMPLOYMENT_TYPE
                  - WORK_AUTH
                  - WALLET
                  - BENEFITS_NETWORK
                  - ADDITIONAL_COMPENSATION
                  - STABLECOIN_ALLOCATION
                  - PROVIDENT_FUND
              - const: TIME_OFF
              - const: BASE_SALARY
          description: >-
            The stored categories, plus TIME_OFF (leave, merged into the feed at
            read time) and

            BASE_SALARY (the salary half of EMPLOYMENT), which the dashboard
            filters on.
        orgIDs:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 200
        orgTypes:
          type: array
          items:
            type: string
            enum:
              - CLIENT_ORGANIZATION
              - DEMO_ORGANIZATION
              - TOKU_ORGANIZATION
              - STABLECOIN_DEMO_ORGANIZATION
        countries:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 100
          maxItems: 200
        employmentTypes:
          type: array
          items:
            type: string
            enum:
              - CONTRACTOR
              - EMPLOYEE
              - EX_EMPLOYEE
              - ADVISOR
              - SERVICE_PROVIDER
              - OTHER
        requestedByRoleInOrgIDs:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 200
        terminationBatchId:
          type: string
          format: uuid
        sortBy:
          type: string
          enum:
            - requestedAt
            - employeeName
            - orgName
            - status
            - category
        sortDirection:
          type: string
          enum:
            - asc
            - desc
        limit:
          type: integer
          minimum: 1
          maximum: 200
        offset:
          type: integer
          minimum: 0
          maximum: 10000
        includeTimeOff:
          type: boolean
    GetHrisChangeRequestsResponse:
      type: object
      properties:
        requests:
          type: array
          items: {}
        total:
          type: integer
        pendingTotal:
          type: integer
      description: Request regeneration does not infer response shapes.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
