---
title: "List Company Payroll Calendar"
method: GET
path: "/v1/payroll-calendars/{cycle}"
tags: ["Payroll Calendars"]
---

# List Company Payroll Calendar

`GET /v1/payroll-calendars/{cycle}`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/payroll-calendars/{cycle}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `payroll_calendar:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `payroll_calendar:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

List all payroll calendars for the company within the requested cycle.

## Authentication

This endpoint accepts any one of the following token types:

- **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too.

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - |
| Company-scoped access token (assertion) | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - |
| Customer API token | Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - |

## Path parameters

- `cycle` string, required

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

Success

- PayrollCalendarsResponse: Response schema listing many payroll_calendars
  - `data` object
    - `current_page` integer: The current page among all of the total_pages
    - `payroll_calendars` PayrollCalendar[]
      - `country` Country, required: A supported country on Remote
        - `alpha_2_code` string, required: The ISO 3166-1 alpha-2 country code (e.g., "PT").
        - `code` string, required: The ISO 3166-1 alpha-3 country code (e.g., "PRT"). This is the primary code used across the Remote API.
        - `contractor_products_available` string[]: Contractor product names available for this country
        - `country_subdivisions` CountrySubdivision[], nullable: Administrative subdivisions of the country (e.g., states, provinces, districts). Null if the country has no subdivisions relevant to Remote's services.
          - `code` string: The ISO 3166-2 subdivision code (e.g., "PT-11" for Lisboa).
          - `name` string, required: The subdivision's name (e.g., "Lisboa", "California").
          - `subdivision_type` string: The type of subdivision (e.g., "District", "State", "Province").
        - `employment_agreement_preview_available` boolean: Whether an Employment Agreement preview is available for this country.
        - `eor_onboarding` boolean: Whether EOR (Employer of Record) onboarding is available in this country.
        - `global_payroll_supported` boolean: Whether Global Payroll employments can be onboarded in this country. When true, the "global_payroll_administrative_details", "global_payroll_contract_details" and "global_payroll_personal_details" forms are available from the Show form schema endpoint.
        - `locked_benefits` string: When benefit plan selections become locked for this country (e.g., "after_first_hire" means benefits cannot be changed after the first employee is hired).
        - `name` string, required: The country's full English name.
        - `region` string: The geographic region the country belongs to (e.g., "Europe", "Asia", "Americas").
        - `subregion` string, nullable: The geographic subregion (e.g., "Southern Europe", "Southeast Asia"). Null for some countries.
        - `supported_json_schemas` string[]: The list of JSON schema form names available for this country (e.g., "address_details", "contract_details", "global_payroll_contract_details"). Use these with the Show form schema endpoint to get country-specific field requirements.
      - `cycle_frequency` 'monthly' | 'bi_monthly' | 'bi_weekly' | 'weekly', required: The frequency at which the payroll calendar is run.
      - `cycles` Cycle[], required
        - `employee_inclusion_cutoff_date` string, date
        - `end_date` string, date
        - `input_cutoff_date` string, date
        - `payment_date` string, date
        - `start_date` string, date
      - `owned_by_remote` boolean, required
    - `total_count` integer: The total number of records in the result
    - `total_pages` integer: The total number of pages the user can go through

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/remote-com/apis/pay-compensation.md) - [All operations](https://skmtc.dev/remote-com/apis/pay-compensation/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/pay-compensation/revisions/ec29f1865c5e?raw)