Shifts

Retrieve a single shift by id

get/shifts/{id}

Request

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

Path parameters

idstring required

Response

Successful response

object'shift' required
idstring required
worker_idstring nullable
assignment_idstring nullable
pay_cycle_idstring nullable
datestring date nullable
status'draft' | 'submitted' | 'approved' | 'null' nullable
descriptionstring nullable
reference_numberstring nullable

Example response

{
  "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",
  "status": "draft",
  "description": "Handle inbound customer inquiries via phone, email, and chat.",
  "reference_number": "PO-12345",
  "submission": {
    "submitted_at": "2024-06-15T14:30:00Z"
  },
  "hours": {
    "total_hours": 7.5,
    "payable_hours": 15.5,
    "reported_by_employee": {
      "break": 0.5,
      "holiday_non_worked": 8,
      "starts_at": "2024-06-15T14:30:00Z",
      "ends_at": "2024-06-15T14:30:00Z"
    },
    "reported_by_employer": {
      "break_override": 0.5,
      "holiday_non_worked_override": 8,
      "total_hours_worked_override": 7.5
    }
  },
  "approval": {
    "approved_at": "2024-06-15T14:30:00Z",
    "approved_by": {
      "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.