HIhibob
Pay cycles

List pay cycles for employer

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.

get/payroll/hub/us/employers/{employerId}/pay-cycles

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/payroll/hub/us/employers/{employerId}/pay-cycles
  • Auth
    HTTP bearer

Path parameters

employerIdstring required

Unique identifier of the employer. Obtain from ListEmployers.

Query parameters

start_datestring

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

end_datestring

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

cursorstring

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

limitinteger

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

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.