> ## 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 Employee Sync Job Status

> Returns one employee sync run with computed progress percentage and completion flag.

Not available to API keys.

## OpenAPI

````yaml api-reference/openapi.json GET /platform/get-employee-sync-job-status
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /platform/get-employee-sync-job-status:
    get:
      operationId: getEmployeeSyncJobStatus
      summary: Get Employee Sync Job Status
      description: >-
        Returns one employee sync run with computed progress percentage and
        completion flag.


        Not available to API keys.
      parameters:
        - name: syncHistoryId
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmployeeSyncJobStatusResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetEmployeeSyncJobStatusResponse:
      type: object
      properties:
        id:
          type: string
        orgID:
          type: string
        syncRunId:
          type: string
        syncType:
          type: string
        syncSource:
          type: string
        totalRecords:
          type: integer
        filteredRecords:
          type: integer
        processedRecords:
          type: integer
        createdRecords:
          type: integer
        updatedRecords:
          type: integer
        failedRecords:
          type: integer
        startedAt:
          type: string
        completedAt:
          type:
            - string
            - 'null'
        durationMs:
          type:
            - integer
            - 'null'
        status:
          type: string
        errors:
          type:
            - object
            - 'null'
          properties:
            message:
              type: string
            messages:
              type: array
              items:
                type: string
            pendingCredentialRequests:
              type: array
              items:
                type: object
                properties:
                  requestID:
                    type:
                      - string
                      - 'null'
                  userID:
                    type: string
                  roleInOrgID:
                    type: string
                  destination:
                    type: string
                  status:
                    type: string
                    enum:
                      - REQUESTED
                      - ADMIN_REQUEST_REQUIRED
                  notificationFailed:
                    type: boolean
                required:
                  - requestID
                  - userID
                  - roleInOrgID
                  - destination
                  - status
        triggerJobId:
          type:
            - string
            - 'null'
        isComplete:
          type: boolean
        progress:
          type: number
      required:
        - id
        - orgID
        - syncRunId
        - syncType
        - syncSource
        - totalRecords
        - filteredRecords
        - processedRecords
        - createdRecords
        - updatedRecords
        - failedRecords
        - startedAt
        - completedAt
        - durationMs
        - status
        - errors
        - triggerJobId
        - isComplete
        - progress
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
