Command Palette

Search for a command to run...

Log In
Get help

Get a Shift

get/public/v1/shifts/{shift}

Alpha — this endpoint is in an alpha stage and the response structure may change at any time without notice.

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • shiftstringrequired

    The shift UUID

Response

200application/json

ShiftResource

  • dataobjectrequired
    ▶Show 18 child attributes
    • idstringrequired
      Example:s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c
    • event_typestringrequired
      Example:support
    • namestring | nullrequired
      Example:Team Meeting
    • start_timestringrequired
      Example:2024-01-15T10:30:00+00:00
    • end_timestringrequired
      Example:2024-01-15T12:30:00+00:00
    • timezonestringrequired
      Example:Australia/Sydney
    • statusstringrequired
      Example:published
    • is_cancelledboolean

      True once the shift's support, or its whole group support, is cancelled. Cancelled shifts are still returned, so filter on this.

      Example:false
    • cancelled_atstring | null
      Example:2024-01-14T21:05:00+00:00
    • clock_in_atstring | nullrequired
      Example:2024-01-15T10:32:00+00:00
    • clock_out_atstring | nullrequired
      Example:2024-01-15T12:28:00+00:00
    • hours_approved_atstring | nullrequired
      Example:2024-01-16T09:15:00+00:00
    • timesheet_batchobject | nullrequired
      ▶Show 4 child attributes
      • idstringrequired
        Example:t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b
      • startstringrequired
        Example:2024-01-07T13:00:00+00:00
      • endstringrequired
        Example:2024-01-21T12:59:59+00:00
      • created_atstringrequired
        Example:2024-01-22T09:30:00+00:00
    • userobject | nullrequired
      ▶Show 2 child attributes
      • idstringrequired
        Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
      • namestringrequired
        Example:Jane Smith
    • supportobject | nullrequired
      ▶Show 15 child attributes
      • idstringrequired
        Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
      • start_timestringrequired
        Example:2024-01-15T10:30:00+00:00
      • end_timestringrequired
        Example:2024-01-15T12:30:00+00:00
      • timezonestringrequired
        Example:Australia/Sydney
      • detailsstring | nullrequired
        Example:Community access support
      • is_sleepoverbooleanrequired
        Example:false
      • sleepover_starts_atstring | nullrequired
        Example:2024-01-15T22:00:00+00:00
      • sleepover_ends_atstring | nullrequired
        Example:2024-01-16T06:00:00+00:00
      • address_statestring | null
        Example:NSW
      • is_part_of_group_supportbooleanrequired
        Example:false
      • group_supportobject | null
        ▶Show 1 child attributes
        • idstringrequired
          Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
      • participantobject
        ▶Show 2 child attributes
        • idstringrequired
          Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
        • namestringrequired
          Example:John Doe
      • shiftsobject[]
        ▶Show 18 child attributes
        • idstringrequired
          Example:s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c
        • event_typestringrequired
          Example:support
        • namestring | nullrequired
          Example:Team Meeting
        • start_timestringrequired
          Example:2024-01-15T10:30:00+00:00
        • end_timestringrequired
          Example:2024-01-15T12:30:00+00:00
        • timezonestringrequired
          Example:Australia/Sydney
        • statusstringrequired
          Example:published
        • is_cancelledboolean

          True once the shift's support, or its whole group support, is cancelled. Cancelled shifts are still returned, so filter on this.

          Example:false
        • cancelled_atstring | null
          Example:2024-01-14T21:05:00+00:00
        • clock_in_atstring | nullrequired
          Example:2024-01-15T10:32:00+00:00
        • clock_out_atstring | nullrequired
          Example:2024-01-15T12:28:00+00:00
        • hours_approved_atstring | nullrequired
          Example:2024-01-16T09:15:00+00:00
        • timesheet_batchobject | nullrequired
          ▶Show 4 child attributes
          • idstringrequired
            Example:t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b
          • startstringrequired
            Example:2024-01-07T13:00:00+00:00
          • endstringrequired
            Example:2024-01-21T12:59:59+00:00
          • created_atstringrequired
            Example:2024-01-22T09:30:00+00:00
        • userobject | nullrequired
          ▶Show 2 child attributes
          • idstringrequired
            Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
          • namestringrequired
            Example:Jane Smith
        • supportobject | null
        • group_supportobject | null
          ▶Show 15 child attributes
          • idstringrequired
            Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
          • namestringrequired
            Example:Saturday Social Group
          • start_timestringrequired
            Example:2024-01-15T10:30:00+00:00
          • end_timestringrequired
            Example:2024-01-15T14:30:00+00:00
          • timezonestringrequired
            Example:Australia/Sydney
          • detailsstringrequired
            Example:Group outing to the park
          • is_sleepoverbooleanrequired
            Example:false
          • sleepover_starts_atstring | nullrequired
            Example:2024-01-15T22:00:00+00:00
          • sleepover_ends_atstring | nullrequired
            Example:2024-01-16T06:00:00+00:00
          • address_statestring | null
            Example:NSW
          • participantsobject[]
            ▶Show 2 child attributes
            • idstringrequired
              Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
            • namestringrequired
              Example:John Doe
          • supportsobject[]
            ▶Show 1 child attributes
            • idstringrequired
              Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
          • shiftsobject[]
            ▶Show 18 child attributes
            • idstringrequired
              Example:s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c
            • event_typestringrequired
              Example:support
            • namestring | nullrequired
              Example:Team Meeting
            • start_timestringrequired
              Example:2024-01-15T10:30:00+00:00
            • end_timestringrequired
              Example:2024-01-15T12:30:00+00:00
            • timezonestringrequired
              Example:Australia/Sydney
            • statusstringrequired
              Example:published
            • is_cancelledboolean

              True once the shift's support, or its whole group support, is cancelled. Cancelled shifts are still returned, so filter on this.

              Example:false
            • cancelled_atstring | null
              Example:2024-01-14T21:05:00+00:00
            • clock_in_atstring | nullrequired
              Example:2024-01-15T10:32:00+00:00
            • clock_out_atstring | nullrequired
              Example:2024-01-15T12:28:00+00:00
            • hours_approved_atstring | null
              Example:2024-01-16T09:15:00+00:00
            • timesheet_batchobject | null
              ▶Show 4 child attributes
              • idstringrequired
                Example:t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b
              • startstringrequired
                Example:2024-01-07T13:00:00+00:00
              • endstringrequired
                Example:2024-01-21T12:59:59+00:00
              • created_atstringrequired
                Example:2024-01-22T09:30:00+00:00
            • userobject | null
              ▶Show 2 child attributes
              • idstringrequired
                Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
              • namestringrequired
                Example:Jane Smith
            • supportobject | null
            • group_supportobject | null
            • internal_eventobject | null
              ▶Show 6 child attributes
              • idstringrequired
                Example:i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d
              • namestringrequired
                Example:Team Meeting
              • detailsstring | nullrequired
                Example:Monthly all-staff training session
              • start_timestringrequired
                Example:2024-01-15T10:30:00+00:00
              • end_timestringrequired
                Example:2024-01-15T12:30:00+00:00
              • timezonestringrequired
                Example:Australia/Sydney
            • breaksobject[]
              ▶Show 4 child attributes
              • idstringrequired
                Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
              • typestringrequired
                Example:meal
              • durationintegerrequired
                Example:30
              • is_paidbooleanrequired
                Example:false
          • travelsobject[]
            ▶Show 19 child attributes
            • idstringrequired
              Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
            • travel_anchorstringrequired
              Example:start
            • detailsstring | nullrequired
              Example:Pick up from home
            • distanceintegerrequired
              Example:12
            • durationintegerrequired
              Example:20
            • approved_distanceinteger | nullrequired
              Example:12
            • approved_durationinteger | nullrequired
              Example:20
            • odometer_startinteger | nullrequired
              Example:10450
            • odometer_endinteger | nullrequired
              Example:10462
            • actual_start_timestring | nullrequired
              Example:2024-01-15T10:10:00+00:00
            • actual_end_timestring | nullrequired
              Example:2024-01-15T10:30:00+00:00
            • actual_distanceinteger | nullrequired
              Example:12
            • actual_durationinteger | nullrequired
              Example:20
            • was_not_travelledboolean | nullrequired
              Example:false
            • is_unscheduledbooleanrequired
              Example:false
            • group_travel_idstring | nullrequired
              Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
            • shared_with_countintegerrequired
              Example:3
            • userobject | null
              ▶Show 2 child attributes
              • idstringrequired
                Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
              • namestringrequired
                Example:Jane Smith
            • participantsobject[]required
              ▶Show 2 child attributes
              • idstringrequired
                Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
              • namestringrequired
                Example:Alice Walker
          • siteobject | null
            ▶Show 2 child attributes
            • idstringrequired
              Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
            • namestringrequired
              Example:Main Street House
        • internal_eventobject | null
          ▶Show 6 child attributes
          • idstringrequired
            Example:i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d
          • namestringrequired
            Example:Team Meeting
          • detailsstring | nullrequired
            Example:Monthly all-staff training session
          • start_timestringrequired
            Example:2024-01-15T10:30:00+00:00
          • end_timestringrequired
            Example:2024-01-15T12:30:00+00:00
          • timezonestringrequired
            Example:Australia/Sydney
        • breaksobject[]required
          ▶Show 4 child attributes
          • idstringrequired
            Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
          • typestringrequired
            Example:meal
          • durationintegerrequired
            Example:30
          • is_paidbooleanrequired
            Example:false
      • travelsobject[]
        ▶Show 19 child attributes
        • idstringrequired
          Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
        • travel_anchorstringrequired
          Example:start
        • detailsstring | nullrequired
          Example:Pick up from home
        • distanceintegerrequired
          Example:12
        • durationintegerrequired
          Example:20
        • approved_distanceinteger | nullrequired
          Example:12
        • approved_durationinteger | nullrequired
          Example:20
        • odometer_startinteger | nullrequired
          Example:10450
        • odometer_endinteger | nullrequired
          Example:10462
        • actual_start_timestring | nullrequired
          Example:2024-01-15T10:10:00+00:00
        • actual_end_timestring | nullrequired
          Example:2024-01-15T10:30:00+00:00
        • actual_distanceinteger | nullrequired
          Example:12
        • actual_durationinteger | nullrequired
          Example:20
        • was_not_travelledboolean | nullrequired
          Example:false
        • is_unscheduledbooleanrequired
          Example:false
        • group_travel_idstring | nullrequired
          Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
        • shared_with_countintegerrequired
          Example:3
        • userobject | nullrequired
          ▶Show 2 child attributes
          • idstringrequired
            Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
          • namestringrequired
            Example:Jane Smith
        • participantsobject[]required
          ▶Show 2 child attributes
          • idstringrequired
            Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
          • namestringrequired
            Example:Alice Walker
      • siteobject | null
        ▶Show 2 child attributes
        • idstringrequired
          Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
        • namestringrequired
          Example:Main Street House
    • group_supportobject | nullrequired
      ▶Show 15 child attributes
      • idstringrequired
        Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
      • namestringrequired
        Example:Saturday Social Group
      • start_timestringrequired
        Example:2024-01-15T10:30:00+00:00
      • end_timestringrequired
        Example:2024-01-15T14:30:00+00:00
      • timezonestringrequired
        Example:Australia/Sydney
      • detailsstringrequired
        Example:Group outing to the park
      • is_sleepoverbooleanrequired
        Example:false
      • sleepover_starts_atstring | nullrequired
        Example:2024-01-15T22:00:00+00:00
      • sleepover_ends_atstring | nullrequired
        Example:2024-01-16T06:00:00+00:00
      • address_statestring | null
        Example:NSW
      • participantsobject[]
        ▶Show 2 child attributes
        • idstringrequired
          Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
        • namestringrequired
          Example:John Doe
      • supportsobject[]
        ▶Show 1 child attributes
        • idstringrequired
          Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
      • shiftsobject[]
        ▶Show 18 child attributes
        • idstringrequired
          Example:s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c
        • event_typestringrequired
          Example:support
        • namestring | nullrequired
          Example:Team Meeting
        • start_timestringrequired
          Example:2024-01-15T10:30:00+00:00
        • end_timestringrequired
          Example:2024-01-15T12:30:00+00:00
        • timezonestringrequired
          Example:Australia/Sydney
        • statusstringrequired
          Example:published
        • is_cancelledboolean

          True once the shift's support, or its whole group support, is cancelled. Cancelled shifts are still returned, so filter on this.

          Example:false
        • cancelled_atstring | null
          Example:2024-01-14T21:05:00+00:00
        • clock_in_atstring | nullrequired
          Example:2024-01-15T10:32:00+00:00
        • clock_out_atstring | nullrequired
          Example:2024-01-15T12:28:00+00:00
        • hours_approved_atstring | null
          Example:2024-01-16T09:15:00+00:00
        • timesheet_batchobject | null
          ▶Show 4 child attributes
          • idstringrequired
            Example:t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b
          • startstringrequired
            Example:2024-01-07T13:00:00+00:00
          • endstringrequired
            Example:2024-01-21T12:59:59+00:00
          • created_atstringrequired
            Example:2024-01-22T09:30:00+00:00
        • userobject | null
          ▶Show 2 child attributes
          • idstringrequired
            Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
          • namestringrequired
            Example:Jane Smith
        • supportobject | null
          ▶Show 15 child attributes
          • idstringrequired
            Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
          • start_timestringrequired
            Example:2024-01-15T10:30:00+00:00
          • end_timestringrequired
            Example:2024-01-15T12:30:00+00:00
          • timezonestringrequired
            Example:Australia/Sydney
          • detailsstring | nullrequired
            Example:Community access support
          • is_sleepoverbooleanrequired
            Example:false
          • sleepover_starts_atstring | nullrequired
            Example:2024-01-15T22:00:00+00:00
          • sleepover_ends_atstring | nullrequired
            Example:2024-01-16T06:00:00+00:00
          • address_statestring | null
            Example:NSW
          • is_part_of_group_supportbooleanrequired
            Example:false
          • group_supportobject | null
            ▶Show 1 child attributes
            • idstringrequired
              Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
          • participantobject
            ▶Show 2 child attributes
            • idstringrequired
              Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
            • namestringrequired
              Example:John Doe
          • shiftsobject[]
          • travelsobject[]
            ▶Show 19 child attributes
            • idstringrequired
              Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
            • travel_anchorstringrequired
              Example:start
            • detailsstring | nullrequired
              Example:Pick up from home
            • distanceintegerrequired
              Example:12
            • durationintegerrequired
              Example:20
            • approved_distanceinteger | nullrequired
              Example:12
            • approved_durationinteger | nullrequired
              Example:20
            • odometer_startinteger | nullrequired
              Example:10450
            • odometer_endinteger | nullrequired
              Example:10462
            • actual_start_timestring | nullrequired
              Example:2024-01-15T10:10:00+00:00
            • actual_end_timestring | nullrequired
              Example:2024-01-15T10:30:00+00:00
            • actual_distanceinteger | nullrequired
              Example:12
            • actual_durationinteger | nullrequired
              Example:20
            • was_not_travelledboolean | nullrequired
              Example:false
            • is_unscheduledbooleanrequired
              Example:false
            • group_travel_idstring | nullrequired
              Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
            • shared_with_countintegerrequired
              Example:3
            • userobject | nullrequired
              ▶Show 2 child attributes
              • idstringrequired
                Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
              • namestringrequired
                Example:Jane Smith
            • participantsobject[]required
              ▶Show 2 child attributes
              • idstringrequired
                Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
              • namestringrequired
                Example:Alice Walker
          • siteobject | null
            ▶Show 2 child attributes
            • idstringrequired
              Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
            • namestringrequired
              Example:Main Street House
        • group_supportobject | null
        • internal_eventobject | null
          ▶Show 6 child attributes
          • idstringrequired
            Example:i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d
          • namestringrequired
            Example:Team Meeting
          • detailsstring | nullrequired
            Example:Monthly all-staff training session
          • start_timestringrequired
            Example:2024-01-15T10:30:00+00:00
          • end_timestringrequired
            Example:2024-01-15T12:30:00+00:00
          • timezonestringrequired
            Example:Australia/Sydney
        • breaksobject[]
          ▶Show 4 child attributes
          • idstringrequired
            Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
          • typestringrequired
            Example:meal
          • durationintegerrequired
            Example:30
          • is_paidbooleanrequired
            Example:false
      • travelsobject[]
        ▶Show 19 child attributes
        • idstringrequired
          Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
        • travel_anchorstringrequired
          Example:start
        • detailsstring | nullrequired
          Example:Pick up from home
        • distanceintegerrequired
          Example:12
        • durationintegerrequired
          Example:20
        • approved_distanceinteger | nullrequired
          Example:12
        • approved_durationinteger | nullrequired
          Example:20
        • odometer_startinteger | nullrequired
          Example:10450
        • odometer_endinteger | nullrequired
          Example:10462
        • actual_start_timestring | nullrequired
          Example:2024-01-15T10:10:00+00:00
        • actual_end_timestring | nullrequired
          Example:2024-01-15T10:30:00+00:00
        • actual_distanceinteger | nullrequired
          Example:12
        • actual_durationinteger | nullrequired
          Example:20
        • was_not_travelledboolean | nullrequired
          Example:false
        • is_unscheduledbooleanrequired
          Example:false
        • group_travel_idstring | nullrequired
          Example:t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b
        • shared_with_countintegerrequired
          Example:3
        • userobject | null
          ▶Show 2 child attributes
          • idstringrequired
            Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
          • namestringrequired
            Example:Jane Smith
        • participantsobject[]required
          ▶Show 2 child attributes
          • idstringrequired
            Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
          • namestringrequired
            Example:Alice Walker
      • siteobject | null
        ▶Show 2 child attributes
        • idstringrequired
          Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
        • namestringrequired
          Example:Main Street House
    • internal_eventobject | nullrequired
      ▶Show 6 child attributes
      • idstringrequired
        Example:i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d
      • namestringrequired
        Example:Team Meeting
      • detailsstring | nullrequired
        Example:Monthly all-staff training session
      • start_timestringrequired
        Example:2024-01-15T10:30:00+00:00
      • end_timestringrequired
        Example:2024-01-15T12:30:00+00:00
      • timezonestringrequired
        Example:Australia/Sydney
    • breaksobject[]required
      ▶Show 4 child attributes
      • idstringrequired
        Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
      • typestringrequired
        Example:meal
      • durationintegerrequired
        Example:30
      • is_paidbooleanrequired
        Example:false

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found