Get a Support

get/public/v1/supports/{support}

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

get/public/v1/supports/{support}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/supports/{support}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b",
    "start_time": "2024-01-15T10:30:00+00:00",
    "end_time": "2024-01-15T12:30:00+00:00",
    "timezone": "Australia/Sydney",
    "details": "Community access support",
    "is_sleepover": false,
    "sleepover_starts_at": "2024-01-15T22:00:00+00:00",
    "sleepover_ends_at": "2024-01-16T06:00:00+00:00",
    "address_state": "NSW",
    "is_part_of_group_support": false,
    "group_support": {
      "id": "g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p"
    },
    "participant": {
      "id": "p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a",
      "name": "John Doe"
    },
    "shifts": [
      {
        "id": "s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c",
        "event_type": "support",
        "name": "Team Meeting",
        "start_time": "2024-01-15T10:30:00+00:00",
        "end_time": "2024-01-15T12:30:00+00:00",
        "timezone": "Australia/Sydney",
        "status": "published",
        "is_cancelled": false,
        "cancelled_at": "2024-01-14T21:05:00+00:00",
        "clock_in_at": "2024-01-15T10:32:00+00:00",
        "clock_out_at": "2024-01-15T12:28:00+00:00",
        "hours_approved_at": "2024-01-16T09:15:00+00:00",
        "timesheet_batch": {
          "id": "t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b",
          "start": "2024-01-07T13:00:00+00:00",
          "end": "2024-01-21T12:59:59+00:00",
          "created_at": "2024-01-22T09:30:00+00:00"
        },
        "user": {
          "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
          "name": "Jane Smith"
        },
        "support": {
          "id": "s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b",
          "start_time": "2024-01-15T10:30:00+00:00",
          "end_time": "2024-01-15T12:30:00+00:00",
          "timezone": "Australia/Sydney",
          "details": "Community access support",
          "is_sleepover": false,
          "sleepover_starts_at": "2024-01-15T22:00:00+00:00",
          "sleepover_ends_at": "2024-01-16T06:00:00+00:00",
          "address_state": "NSW",
          "is_part_of_group_support": false,
          "group_support": {
            "id": "g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p"
          },
          "participant": {
            "id": "p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a",
            "name": "John Doe"
          },
          "shifts": [
            {
              "id": "s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c",
              "event_type": "support",
              "name": "Team Meeting",
              "start_time": "2024-01-15T10:30:00+00:00",
              "end_time": "2024-01-15T12:30:00+00:00",
              "timezone": "Australia/Sydney",
              "status": "published",
              "is_cancelled": false,
              "cancelled_at": "2024-01-14T21:05:00+00:00",
              "clock_in_at": "2024-01-15T10:32:00+00:00",
              "clock_out_at": "2024-01-15T12:28:00+00:00",
              "hours_approved_at": "2024-01-16T09:15:00+00:00",
              "timesheet_batch": {
                "id": "t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b",
                "start": "2024-01-07T13:00:00+00:00",
                "end": "2024-01-21T12:59:59+00:00",
                "created_at": "2024-01-22T09:30:00+00:00"
              },
              "user": {
                "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
                "name": "Jane Smith"
              },
              "support": {},
              "group_support": {
                "id": "g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p",
                "name": "Saturday Social Group",
                "start_time": "2024-01-15T10:30:00+00:00",
                "end_time": "2024-01-15T14:30:00+00:00",
                "timezone": "Australia/Sydney",
                "details": "Group outing to the park",
                "is_sleepover": false,
                "sleepover_starts_at": "2024-01-15T22:00:00+00:00",
                "sleepover_ends_at": "2024-01-16T06:00:00+00:00",
                "address_state": "NSW",
                "participants": {},
                "supports": {},
                "shifts": {},
                "travels": {},
                "site": null
              },
              "internal_event": {
                "id": "i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d",
                "name": "Team Meeting",
                "details": "Monthly all-staff training session",
                "start_time": "2024-01-15T10:30:00+00:00",
                "end_time": "2024-01-15T12:30:00+00:00",
                "timezone": "Australia/Sydney"
              },
              "breaks": [
                {}
              ]
            }
          ],
          "travels": [
            {
              "id": "t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b",
              "travel_anchor": "start",
              "details": "Pick up from home",
              "distance": 12,
              "duration": 20,
              "approved_distance": 12,
              "approved_duration": 20,
              "odometer_start": 10450,
              "odometer_end": 10462,
              "actual_start_time": "2024-01-15T10:10:00+00:00",
              "actual_end_time": "2024-01-15T10:30:00+00:00",
              "actual_distance": 12,
              "actual_duration": 20,
              "was_not_travelled": false,
              "is_unscheduled": false,
              "group_travel_id": "t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b",
              "shared_with_count": 3,
              "user": {
                "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
                "name": "Jane Smith"
              },
              "participants": [
                {}
              ]
            }
          ],
          "site": {
            "id": "s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
            "name": "Main Street House"
          }
        },
        "group_support": {
          "id": "g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p",
          "name": "Saturday Social Group",
          "start_time": "2024-01-15T10:30:00+00:00",
          "end_time": "2024-01-15T14:30:00+00:00",
          "timezone": "Australia/Sydney",
          "details": "Group outing to the park",
          "is_sleepover": false,
          "sleepover_starts_at": "2024-01-15T22:00:00+00:00",
          "sleepover_ends_at": "2024-01-16T06:00:00+00:00",
          "address_state": "NSW",
          "participants": [
            {
              "id": "p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a",
              "name": "John Doe"
            }
          ],
          "supports": [
            {
              "id": "s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b"
            }
          ],
          "shifts": [
            {
              "id": "s1h2i3f4-t5s6-47a8-9b0c-1d2e3f4a5b6c",
              "event_type": "support",
              "name": "Team Meeting",
              "start_time": "2024-01-15T10:30:00+00:00",
              "end_time": "2024-01-15T12:30:00+00:00",
              "timezone": "Australia/Sydney",
              "status": "published",
              "is_cancelled": false,
              "cancelled_at": "2024-01-14T21:05:00+00:00",
              "clock_in_at": "2024-01-15T10:32:00+00:00",
              "clock_out_at": "2024-01-15T12:28:00+00:00",
              "hours_approved_at": "2024-01-16T09:15:00+00:00",
              "timesheet_batch": {
                "id": "t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b",
                "start": "2024-01-07T13:00:00+00:00",
                "end": "2024-01-21T12:59:59+00:00",
                "created_at": "2024-01-22T09:30:00+00:00"
              },
              "user": {
                "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
                "name": "Jane Smith"
              },
              "support": {
                "id": "s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b",
                "start_time": "2024-01-15T10:30:00+00:00",
                "end_time": "2024-01-15T12:30:00+00:00",
                "timezone": "Australia/Sydney",
                "details": "Community access support",
                "is_sleepover": false,
                "sleepover_starts_at": "2024-01-15T22:00:00+00:00",
                "sleepover_ends_at": "2024-01-16T06:00:00+00:00",
                "address_state": "NSW",
                "is_part_of_group_support": false,
                "group_support": null,
                "participant": {},
                "shifts": {},
                "travels": {},
                "site": null
              },
              "group_support": {},
              "internal_event": {
                "id": "i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d",
                "name": "Team Meeting",
                "details": "Monthly all-staff training session",
                "start_time": "2024-01-15T10:30:00+00:00",
                "end_time": "2024-01-15T12:30:00+00:00",
                "timezone": "Australia/Sydney"
              },
              "breaks": [
                {}
              ]
            }
          ],
          "travels": [
            {
              "id": "t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b",
              "travel_anchor": "start",
              "details": "Pick up from home",
              "distance": 12,
              "duration": 20,
              "approved_distance": 12,
              "approved_duration": 20,
              "odometer_start": 10450,
              "odometer_end": 10462,
              "actual_start_time": "2024-01-15T10:10:00+00:00",
              "actual_end_time": "2024-01-15T10:30:00+00:00",
              "actual_distance": 12,
              "actual_duration": 20,
              "was_not_travelled": false,
              "is_unscheduled": false,
              "group_travel_id": "t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b",
              "shared_with_count": 3,
              "user": {
                "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
                "name": "Jane Smith"
              },
              "participants": [
                {}
              ]
            }
          ],
          "site": {
            "id": "s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
            "name": "Main Street House"
          }
        },
        "internal_event": {
          "id": "i1n2t3e4-r5n6-47a8-9l0e-1v2e3n4t5i6d",
          "name": "Team Meeting",
          "details": "Monthly all-staff training session",
          "start_time": "2024-01-15T10:30:00+00:00",
          "end_time": "2024-01-15T12:30:00+00:00",
          "timezone": "Australia/Sydney"
        },
        "breaks": [
          {
            "id": "b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e",
            "type": "meal",
            "duration": 30,
            "is_paid": false
          }
        ]
      }
    ],
    "travels": [
      {
        "id": "t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b",
        "travel_anchor": "start",
        "details": "Pick up from home",
        "distance": 12,
        "duration": 20,
        "approved_distance": 12,
        "approved_duration": 20,
        "odometer_start": 10450,
        "odometer_end": 10462,
        "actual_start_time": "2024-01-15T10:10:00+00:00",
        "actual_end_time": "2024-01-15T10:30:00+00:00",
        "actual_distance": 12,
        "actual_duration": 20,
        "was_not_travelled": false,
        "is_unscheduled": false,
        "group_travel_id": "t1r2a3v4-e5l6-47s8-9a0b-1c2d3e4f5a6b",
        "shared_with_count": 3,
        "user": {
          "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
          "name": "Jane Smith"
        },
        "participants": [
          {
            "id": "p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d",
            "name": "Alice Walker"
          }
        ]
      }
    ],
    "site": {
      "id": "s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "name": "Main Street House"
    }
  }
}

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

supportstringrequired
The support UUID

Response

200application/json

SupportResource

dataobjectrequired
▶Show 15 child attributesHide 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 | nullrequired
  Example:NSW
- is_part_of_group_supportbooleanrequired
  Example:false
- group_supportobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
- participantobjectrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
- shiftsobject[]required
  ▶Show 18 child attributesHide 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 attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  supportobject | null
  ▶Show 15 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
  participantobject
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
  shiftsobject[]
  ▶Show 18 child attributesHide 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 attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  supportobject | null
  group_supportobject | null
  ▶Show 15 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
  supportsobject[]
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
  shiftsobject[]
  ▶Show 18 child attributesHide 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 attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  supportobject | null
  group_supportobject | null
  internal_eventobject | null
  ▶Show 6 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
  typestringrequired
  Example:meal
  durationintegerrequired
  Example:30
  is_paidbooleanrequired
  Example:false
  travelsobject[]
  ▶Show 19 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  participantsobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
  namestringrequired
  Example:Alice Walker
  siteobject | null
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Main Street House
  internal_eventobject | null
  ▶Show 6 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
  typestringrequired
  Example:meal
  durationintegerrequired
  Example:30
  is_paidbooleanrequired
  Example:false
  travelsobject[]
  ▶Show 19 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  participantsobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
  namestringrequired
  Example:Alice Walker
  siteobject | null
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Main Street House
  group_supportobject | null
  ▶Show 15 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
  supportsobject[]
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:s1u2p3p4-o5r6-47t8-9a0b-1c2d3e4f5a6b
  shiftsobject[]
  ▶Show 18 child attributesHide 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 attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  supportobject | null
  ▶Show 15 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:g1r2o3u4-p5s6-47u8-9p0p-1o2r3t4s5u6p
  participantobject
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
  shiftsobject[]
  travelsobject[]
  ▶Show 19 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  participantsobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
  namestringrequired
  Example:Alice Walker
  siteobject | null
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Main Street House
  group_supportobject | null
  internal_eventobject | null
  ▶Show 6 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
  typestringrequired
  Example:meal
  durationintegerrequired
  Example:30
  is_paidbooleanrequired
  Example:false
  travelsobject[]
  ▶Show 19 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  participantsobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
  namestringrequired
  Example:Alice Walker
  siteobject | null
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Main Street House
  internal_eventobject | null
  ▶Show 6 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:b1r2e3a4-k5s6-47i8-9d0e-1f2a3b4c5d6e
  typestringrequired
  Example:meal
  durationintegerrequired
  Example:30
  is_paidbooleanrequired
  Example:false
- travelsobject[]required
  ▶Show 19 child attributesHide 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 attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Jane Smith
  participantsobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-i5c6-47i8-9p0a-1n2t3a4b5c6d
  namestringrequired
  Example:Alice Walker
- siteobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Main Street House

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors