---
title: "Retrieve a pay schedule calendar URL"
method: GET
path: "/pay_schedules/{pay_schedule}/calendar_url"
tags: ["Pay Schedules"]
---

# Retrieve a pay schedule calendar URL

`GET /pay_schedules/{pay_schedule}/calendar_url`

## Request

- Base URL: `https://sandbox.nmbr.co/services/payroll`
- URL: `https://sandbox.nmbr.co/services/payroll/pay_schedules/{pay_schedule}/calendar_url`
- Auth: HTTP bearer

Returns the calendar subscription URL for the pay schedule. The URL serves an iCalendar feed with an event for each payroll's approval deadline and pay date, and can be added to Google Calendar, Apple Calendar or Outlook. Returns a 404 when no URL has been created for the pay schedule.

## Path parameters

- `pay_schedule` string, required

## Query parameters

- `locale` 'en' | 'fr'

## Response `200`

OK

- unknown

## Changes

- **2026-09-29** `c42443c08e9e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nmbr/apis/nmbr-api/changes/pay_schedules/:pay_schedule/calendar_url/get.md)

---

[API](https://skmtc.dev/nmbr/apis/nmbr-api.md) - [All operations](https://skmtc.dev/nmbr/apis/nmbr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmbr/apis/nmbr-api/revisions/3a5d58d37d2c?raw)