HIhireart
Shifts

List all shifts

get/shifts

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

job_idstring

Filter by job id

pay_cycle_idstring

Filter by pay cycle id

datestring date

Shift date is on this date (YYYY-MM-DD)

date_gtstring date

Shift date is after this date (YYYY-MM-DD)

date_gtestring date

Shift date is on or after this date (YYYY-MM-DD)

date_ltstring date

Shift date is before this date (YYYY-MM-DD)

date_ltestring date

Shift date 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": "shift",
      "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
      "worker_id": "1ccf6e61-376c-47d3-8a63-a8ee112e83a2",
      "assignment_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
      "pay_cycle_id": "1aecf7c8-9d70-433a-9bb5-473cf4907a86",
      "date": null,
      "status": "draft",
      "description": "Handle inbound customer inquiries via phone, email, and chat.",
      "reference_number": "PO-12345",
      "submission": {
        "object": "shift_submission",
        "auto_submitted": false,
        "submitted_at": "2024-06-15T14:30:00Z"
      },
      "hours": {
        "object": "shift_hours",
        "total_hours": 7.5,
        "payable_hours": 15.5,
        "reported_by_employee": {
          "object": "employee_reported_hours",
          "break": 0.5,
          "holiday_non_worked": 8,
          "starts_at": "2024-06-15T14:30:00Z",
          "ends_at": "2024-06-15T14:30:00Z"
        },
        "reported_by_employer": {
          "object": "employer_reported_hours",
          "break_override": 0.5,
          "holiday_non_worked_override": 8,
          "total_hours_worked_override": 7.5
        }
      },
      "approval": {
        "object": "shift_approval",
        "approved_at": "2024-06-15T14:30:00Z",
        "auto_approved": false,
        "approved_by": {
          "object": "person",
          "id": "97811bd6-539f-4a58-8be3-6bbe3acfdae0",
          "full_name": "Jane Doe",
          "first_name": "Jane",
          "last_name": "Doe",
          "email": "jane.doe@example.com",
          "phone": "+1 (555) 555-5555"
        }
      }
    }
  ]
}

Changes

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