---
title: "GET /api/tenants/{tenantId}/payruns/jobs/{payrunJobId}"
method: GET
path: "/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}"
tags: ["Payrun jobs"]
---

# GET /api/tenants/{tenantId}/payruns/jobs/{payrunJobId}

`GET /api/tenants/{tenantId}/payruns/jobs/{payrunJobId}`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/docs/api/tenants/:tenantId/payruns/jobs/:payrunJobId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantId` integer, required
- `payrunJobId` integer, required

## Response `200`

OK

- PayrunJob
  - `id` integer
  - `status` 'Active' | 'Inactive': The object status
  - `created` string, date-time
  - `updated` string, date-time
  - `name` string, required
  - `owner` string, nullable
  - `payrunId` integer, required
  - `payrollId` integer, required
  - `divisionId` integer
  - `parentJobId` integer, nullable
  - `createdUserId` integer, required
  - `releasedUserId` integer, nullable
  - `processedUserId` integer, nullable
  - `finishedUserId` integer, nullable
  - `retroPayMode` 'ValueChange' | 'None': The payrun retro pay mode
  - `jobStatus` 'Draft' | 'Release' | 'Process' | 'Complete' | 'Forecast' | 'Abort' | 'Cancel': The payrun job status Supported state changes: - *: Draft | Forecast | Abort - Draft: Release | Abort - Release: Process | Abort - Process: Complete | Cancel
  - `jobResult` 'Full' | 'Incremental': The payrun job result
  - `tags` string[], nullable
  - `forecast` string, nullable
  - `cycleName` string, required
  - `cycleStart` string, date-time, required
  - `cycleEnd` string, date-time, required
  - `periodName` string, required
  - `periodStart` string, date-time, required
  - `periodEnd` string, date-time, required
  - `evaluationDate` string, date-time, required
  - `payDate` string, date-time
  - `released` string, date-time, nullable
  - `processed` string, date-time, nullable
  - `finished` string, date-time, nullable
  - `createdReason` string, required
  - `releasedReason` string, nullable
  - `processedReason` string, nullable
  - `finishedReason` string, nullable
  - `totalEmployeeCount` integer
  - `processedEmployeeCount` integer
  - `jobStart` string, date-time, required
  - `jobEnd` string, date-time, nullable
  - `message` string, nullable
  - `errorMessage` string, nullable
  - `employees` PayrunJobEmployee[], nullable
    - `id` integer
    - `status` 'Active' | 'Inactive': The object status
    - `created` string, date-time
    - `updated` string, date-time
    - `employeeId` integer, required
  - `attributes` object, nullable

## Other responses

- `404`: Not Found

## Changes

- **2026-10-13** `e3e4305cbb92`: 1 info
  - added the optional property `payDate` to the response with the `200` status
- **2026-04-01** `34e260deaa2c`: 1 warning
  - removed the optional property `culture` from the response with the `200` status
- **2023-07-23** `fd1b5146be4a`: 1 info
  - added the optional property `culture` to the response with the `200` status

[Operation history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/payruns/jobs/:payrunJobId/get.md)

---

[API](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1.md) - [All operations](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/revisions/d1227845e767?raw)