HIhibob
Pay cycles

Get pay cycle by ID

Beta. Returns metadata for a single pay cycle. Use after receiving a payroll.paycycle.paid webhook to fetch the pay cycle window, or when you have a payCycleId from ListPayCyclesForEmployer.

Rate limit: 5 requests per minute per authenticated caller.

get/payroll/hub/us/pay-cycles/{payCycleId}

Request

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

Path parameters

payCycleIdstring required

Unique identifier of the pay cycle.

Response

Success

payCycleIdstring required

Unique identifier of the pay cycle.

payDatestring nullable

Date when payment is made to the employees in this cycle (ISO 8601 calendar date, YYYY-MM-DD). Absent for cycles that have not been paid yet.

periodStartstring required

First day of the pay period covered by this cycle.

periodEndstring nullable

Last day of the pay period covered by this cycle. Absent for open-ended cycles.

Changes

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