List Pay Schedules

​

Returns Pay Schedules:

  • From oldest to newest by creation time, then ID.
  • When supplied, partnerPayScheduleId must be one exact, case-sensitive value. The response contains either the matching Pay Schedule or an empty items array.
OAuth scopes
  • employers:read

Path Parameters

  • employerId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit Employer ID.

Query Parameters

  • cursor
    Type: string
    min length:  
    1
    max length:  
    1000

    Unchanged nextCursor value used to retrieve the next page. It is valid for 24 hours and only with the Partner, endpoint and filters that produced it. See Pagination.

  • limit
    Type: integer
    min:  
    1
    max:  
    100

    Number of records to return, from 1 to 100. Defaults to 50. See Pagination.

  • partnerPayScheduleId
    Type: string
    min length:  
    1
    max length:  
    200

    Exact, case-sensitive match for the stable Pay Schedule ID from your product. Use it to recover the corresponding PayrollKit Pay Schedule ID.

Headers

  • X-Request-Id
    Type: stringFormat: uuid

    Client-generated UUID for tracing. This does not make retries safe.

Responses

  • application/json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
  • application/problem+json
get/employers/{employerId}/pay-schedules
Employer's Pay Schedules
{
  "items": [
    {
      "id": "schedule_91ac3e57",
      "partnerPayScheduleId": "monthly_staff",
      "employerId": "er_7d91f2c8",
      "payeSchemeId": "paye_63b8d4f2",
      "frequency": "monthly",
      "firstPayPeriodStartDate": "2026-04-01",
      "paymentDateRule": "last_calendar_day",
      "nonBankingDayRule": "previous_banking_day",
      "bankHolidayRegion": "england_and_wales",
      "createdAt": "2026-08-20T09:05:00Z"
    },
    {
      "id": "schedule_52bd8a73",
      "partnerPayScheduleId": "weekly_staff",
      "employerId": "er_7d91f2c8",
      "payeSchemeId": "paye_63b8d4f2",
      "frequency": "weekly",
      "firstPayPeriodStartDate": "2026-04-06",
      "paymentDateRule": "fixed_weekday",
      "paymentWeekday": "friday",
      "nonBankingDayRule": "previous_banking_day",
      "bankHolidayRegion": "england_and_wales",
      "createdAt": "2026-08-20T09:06:00Z"
    }
  ],
  "nextCursor": null
}

Pay Schedule page