Payroll Information

GET

/payrolls/{payroll_id}

OperationId:get_payroll_information

Ontime calls this endpoint to get a payroll's frequency and future pay dates.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '/payrolls/{{$string.uuid}}' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'

Responses

🟢200

application/json

Indicates the request was successfully processed by the server and a valid response is included in the body.

Bodyapplication/json

Example

{
    "payroll_response": {
        "payroll": {
            "id": "PAYROLL-001",
            "payment_run_frequency": "monthly",
            "pay_dates": [
                {
                    "pay_date": "2026-10-28",
                    "payroll_cutoff": "2026-10-20",
                    "pay_period": "October-26"
                },
                {
                    "pay_date": "2026-11-27",
                    "payroll_cutoff": "2026-11-19",
                    "pay_period": "November-26"
                }
            ]
        }
    }
}

🟠400

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

Salary Deduction Enablement

Salary Deduction Employee Data Push