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

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

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

## 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/actions/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
- `functionType` 'CaseAvailable' | 'CaseBuild' | 'CaseValidate' | 'CaseChange' | 'Case' | 'CaseRelationBuild' | 'CaseRelationValidate' | 'CaseRelation' | 'CollectorStart' | 'CollectorApply' | 'CollectorEnd' | 'Collector' | 'WageTypeValue' | 'WageTypeResult' | 'WageType' | 'PayrunStart' | 'PayrunEmployeeAvailable' | 'PayrunEmployeeStart' | 'PayrunEmployeeEnd' | 'PayrunWageTypeAvailable' | 'PayrunEnd' | 'PayrunBase' | 'Payrun' | 'Payroll' | 'ReportBuild' | 'ReportStart' | 'ReportEnd' | 'Report' | 'All'
- `overrideType` 'Active' | 'Inactive'
- `regulationDate` string, date-time
- `scriptNames` string[]

## Response `200`

OK

- ActionInfo[]
  - `name` string, required
  - `functionType` 'CaseAvailable' | 'CaseBuild' | 'CaseValidate' | 'CaseChange' | 'Case' | 'CaseRelationBuild' | 'CaseRelationValidate' | 'CaseRelation' | 'CollectorStart' | 'CollectorApply' | 'CollectorEnd' | 'Collector' | 'WageTypeValue' | 'WageTypeResult' | 'WageType' | 'PayrunStart' | 'PayrunEmployeeAvailable' | 'PayrunEmployeeStart' | 'PayrunEmployeeEnd' | 'PayrunWageTypeAvailable' | 'PayrunEnd' | 'PayrunBase' | 'Payrun' | 'Payroll' | 'ReportBuild' | 'ReportStart' | 'ReportEnd' | 'Report' | 'All'
  - `namespace` string, nullable
  - `description` string, nullable
  - `categories` string[], nullable
  - `source` 'Script' | 'System'
  - `parameters` ActionParameterInfo[], nullable
    - `name` string, required
    - `description` string, nullable
    - `valueTypes` string[], nullable
    - `valueSources` string[], nullable
    - `valueReferences` string[], nullable
  - `issues` ActionIssueInfo[], nullable
    - `name` string, required
    - `message` string, nullable
    - `parameterCount` integer

## Other responses

- `404`: Not Found

## Changes

- **2026-01-07** `e70510c47700`: 1 warning, 1 info
  - added the new `PayrunBase` enum value to the `items/functionType` response property for the response status `200`
  - added the new enum value `PayrunBase` to the `query` request parameter `functionType`
- **2023-07-23** `fd1b5146be4a`: 1 breaking, 1 info
  - removed the enum value `PayrunBase` from the `query` request parameter `functionType`
  - removed the `PayrunBase` enum value from the `items/functionType` response property for the response status `200`

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