List pay cycles for employer

Discover pay cycles for an employer, with optional date filters and cursor pagination.

Beta. Discovers pay cycles for an employer. Use during partner onboarding
for historical paycheck sync, or to find a payCycleId to pass to the pay
cycle / paychecks endpoints. Supports optional date filters and cursor pagination.

Rate limit: 5 requests per minute per authenticated caller.

Query parameter naming: start_date and end_date use snake_case (not
camelCase like employeeIds elsewhere in this API). The running service
accepts only these spellings today.

Path Params
string
required

Unique identifier of the employer. Obtain from
ListEmployers.

Query Params
string

Filter pay cycles whose period start date is on or after this date
(ISO 8601 calendar date, YYYY-MM-DD).

string

Filter pay cycles whose period end date is on or before this date
(ISO 8601 calendar date, YYYY-MM-DD).

string

Pagination cursor returned by the previous response's responseMetadata.nextCursor.
Omit on the first request.

integer

Maximum number of pay cycles per page (default 10, maximum 50).

Responses

Language
Credentials
Bearer
OAuth 2.0
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json