HIhireart
PayCycles

List all pay cycles

get/pay_cycles

Request

  • Base URL
    https://app.hireart.com/api/v2
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number

per_pageinteger

Number of results per page

worker_idstring

Filter by worker id

periodstring date

Pay cycle start date (the Monday the pay week begins) is on this date (YYYY-MM-DD)

period_gtstring date

Pay cycle start date (the Monday the pay week begins) is after this date (YYYY-MM-DD)

period_gtestring date

Pay cycle start date (the Monday the pay week begins) is on or after this date (YYYY-MM-DD)

period_ltstring date

Pay cycle start date (the Monday the pay week begins) is before this date (YYYY-MM-DD)

period_ltestring date

Pay cycle start date (the Monday the pay week begins) is on or before this date (YYYY-MM-DD)

Response

Successful response

object'list' required
pageinteger required
per_pageinteger required
total_countinteger required
total_pagesinteger required

Example response

{
  "page": 1,
  "per_page": 25,
  "total_count": 42,
  "total_pages": 2,
  "data": [
    {
      "object": "pay_cycle",
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "period": "2024-06-10",
      "hours_submitted_at": "2024-06-15T14:30:00Z",
      "locked_at": "2024-06-15T14:30:00Z"
    }
  ]
}

Changes

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