List payroll calendars

List the company's payroll calendars. Archived calendars are left out unless you pass includeArchived=true. Results are paginated and sorted by effectiveDate, then id, by default. See Pagination and the Guide to the Payroll Calendar API.

Query Params
boolean
Defaults to false

Set to true to include archived calendars. They're excluded otherwise.

integer
Defaults to 0

The page index, starting at 0.

integer

The page size.

string

The property to sort by, optionally followed by a comma and asc or desc. Sortable properties: id, displayName, payPeriodType, effectiveDate, archiveDate. Defaults to effectiveDate then id, ascending.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json