---
title: "Company Pay Frequencies"
method: GET
path: "/companies/{companyId}/payfrequencies"
tags: ["Company"]
---

# Company Pay Frequencies

`GET /companies/{companyId}/payfrequencies`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/companies/{companyId}/payfrequencies`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/payfrequencies/get.ts> (a function with typed inputs; its response is checked against the schema)

Array of pay frequencies that workers maybe paid on. This is a generic array that is currently not specific to the companies pay frequency. This is to be used with the workers pay components to determine what the frequency, occurrence, and intervals are allowed.

## Path parameters

- `companyId` string, required

## Query parameters

- `payfrequency` string

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` FrequencyCombinationUnitResource: The state representation of generic pay frequencies.
    - `payFrequency` string: Frequency which the pay component would be applied.
    - `payComponentFrequency` PayComponentFrequencyTypeResource: Pay Component Frequency
      - `applied` string: Currently we only support a BY_PAY_PERIOD value for the API.
      - `occurrence` string: This is how often the to be applied on the pay run.
      - `occurrenceIntervals` FrequencyIntervalsResource: These are sub intervals that are used for occurrences that are larger in duration that allow you to define when to apply the pay component.
        - `interval1` string: Interval 1
        - `interval2` string: Interval 2
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)