---
title: "GET /api/tenants/{tenantId}/payrolls/{payrollId}/cases"
method: GET
path: "/api/tenants/{tenantId}/payrolls/{payrollId}/cases"
tags: ["Payrolls"]
---

# GET /api/tenants/{tenantId}/payrolls/{payrollId}/cases

`GET /api/tenants/{tenantId}/payrolls/{payrollId}/cases`

## Path parameters

- `tenantId` integer, required
- `payrollId` integer, required

## Query parameters

- `caseNames` string[]
- `caseType` 'Global' | 'National' | 'Company' | 'Employee'
- `clusterSetName` string
- `evaluationDate` string, date-time
- `overrideType` 'Active' | 'Inactive'
- `regulationDate` string, date-time

## Response `200`

OK

- Case[]
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `caseType` 'Global' | 'National' | 'Company' | 'Employee', required
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `nameSynonyms` string[], nullable
  - `description` string, nullable
  - `descriptionLocalizations` object, nullable
  - `defaultReason` string, nullable
  - `defaultReasonLocalizations` object, nullable
  - `baseCase` string, nullable
  - `baseCaseFields` CaseFieldReference[], nullable
    - `name` string, nullable
    - `order` integer, nullable
  - `overrideType` 'Active' | 'Inactive'
  - `cancellationType` 'None' | 'Case'
  - `hidden` boolean
  - `availableExpression` string, nullable
  - `buildExpression` string, nullable
  - `validateExpression` string, nullable
  - `lookups` string[], nullable
  - `slots` CaseSlot[], nullable
    - `name` string, required
    - `nameLocalizations` object, nullable
  - `availableActions` string[], nullable
  - `buildActions` string[], nullable
  - `validateActions` string[], nullable
  - `attributes` object, nullable
  - `clusters` string[], nullable

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1.md) · [All operations](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payroll-engine/payroll-engine-backend-api-v1/versions/34e260deaa2c/schema)