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

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

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

## 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/payrolls/:payrollId/lookups/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

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

## Query parameters

- `evaluationDate` string, date-time
- `lookupNames` string[]
- `overrideType` 'Active' | 'Inactive'
- `regulationDate` string, date-time

## Response `200`

OK

- Lookup[]
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `description` string, nullable
  - `descriptionLocalizations` object, nullable
  - `overrideType` 'Active' | 'Inactive'
  - `rangeMode` 'None' | 'Threshold' | 'Progressive'
  - `rangeSize` number, double, nullable
  - `attributes` object, nullable

## Other responses

- `404`: Not Found

## Changes

- **2025-11-05** `81aecc227d08`: 1 info
  - added the optional property `items/rangeMode` to the response with the `200` status
- **2023-07-23** `fd1b5146be4a`: 1 warning
  - removed the optional property `items/rangeMode` from the response with the `200` status

[Operation history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/payrolls/:payrollId/lookups/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/7e8994a2c5bb?raw)