# Read a shift

Returns one shift with its times, demand figures, location and the settings that
govern applying, checking in and checking out.
`object` holds the stored values and `nice` the same values rendered for display -
dates formatted in the shift's timezone, ids resolved to the names they point at.
`permissions` says what the caller may do with this shift, and `apply_error` says
why applying is refused when it is.
The shift has to belong to the event in the URL; a mismatch is a 404.

Endpoint: GET /api/v2/event/{event_id}/shift/{id}
Version: 2.0.0
Security: default

## Path parameters:

  - `event_id` (integer, required)
    The ID of the event.

  - `id` (integer, required)
    The ID of the shift.

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `object` (object)

  - `object.id` (integer)

  - `object.event_id` (integer)

  - `object.event_shift_type_id` (string | null)

  - `object.event_shift_template_id` (string | null)

  - `object.journey_id` (string | null)

  - `object.min_demand` (integer)

  - `object.max_demand` (integer)

  - `object.leader_demand` (integer)

  - `object.start_timestamp` (string)

  - `object.end_timestamp` (string)

  - `object.timezone` (string)

  - `object.no_shift_time` (integer)

  - `object.apps_open_timestamp` (string | null)

  - `object.apps_close_timestamp` (string | null)

  - `object.headcount_location_venue_id` (string | null)

  - `object.shift_confirmed_status_default` (integer)

  - `object.shift_rejected_status_default` (integer)

  - `object.journey_complete_status` (string | null)

  - `object.shift_can_withdraw_default` (integer)

  - `object.shift_can_confirm` (integer)

  - `object.shift_can_confirm_limit` (integer)

  - `object.shift_can_withdraw_limit` (integer)

  - `object.shift_checked_in_status_default` (integer)

  - `object.shift_checked_out_status_default` (integer)

  - `object.certificate_id` (string | null)

  - `object.shift_application_form_id` (string | null)

  - `object.allow_application_form_resubmit` (integer)

  - `object.shift_checkin_form_id` (string | null)

  - `object.shift_attended_form_id` (string | null)

  - `object.shift_checkout_form_id` (string | null)

  - `object.shift_precheckin_form_id` (string | null)

  - `object.shift_withdraw_form_id` (string | null)

  - `object.training_ids` (string | null)

  - `object.visibility_show_groups` (array)

  - `object.visibility_hide_groups` (array)

  - `object.visibility_show_roleoffer` (array)

  - `object.role_offer_id` (string | null)

  - `object.role_offer_address` (integer)

  - `object.checkin_visible_attributes` (array)

  - `object.shift_enable_waitlist_default` (integer)

  - `object.max_waitlist` (integer)

  - `object.group_booking_ttl` (string | null)

  - `object.max_group_demand` (string | null)

  - `object.max_group_size` (string | null)

  - `object.reserved_expiry` (string | null)

  - `object.minimum_dob` (string | null)

  - `object.minimum_age` (string | null)

  - `object.maximum_dob` (string | null)

  - `object.maximum_age` (string | null)

  - `object.self_checkin` (integer)

  - `object.self_checkin_open` (integer)

  - `object.self_checkin_close` (integer)

  - `object.self_checkout_close` (integer)

  - `object.checkin_close` (integer)

  - `object.shift_precheckin_open` (integer)

  - `object.break` (integer)

  - `object.post_feedback_form` (string | null)

  - `object.shift_leader_feedback_form_id` (string | null)

  - `object.is_virtual` (integer)

  - `object.geofence_checkin_limit` (string | null)

  - `object.tax` (string | null)

  - `object.price_excluding_tax` (integer)

  - `object.tax_percentage` (string | null)

  - `object.publish` (integer)

  - `object.public` (integer)

  - `object.sort_order` (integer)

  - `object.is_cancelled` (integer)

  - `object.deleted_at` (string | null)

  - `object.is_erased` (integer)

  - `object.is_draft` (boolean)

  - `object.created_at` (string)

  - `object.updated_at` (string)

  - `object.deleted_by` (string | null)

  - `object.cost_description` (string | null)

  - `object.event_shift_description` (string)

  - `object.name` (string | null)

  - `object.address` (object)

  - `object.address.iso` (string)

  - `object.address.region_code` (string)

  - `object.address.coordinates` (object)

  - `object.address.coordinates.latitude` (string)

  - `object.address.coordinates.longitude` (string)

  - `object.address.street_address_1` (string)

  - `object.address.street_address_2` (string | null)

  - `object.address.street_address_3` (string | null)

  - `object.address.city` (string)

  - `object.address.postcode` (string)

  - `object.address.region` (string)

  - `object.address.country` (string)

  - `object.address.latitude` (string)

  - `object.address.longitude` (string)

  - `nice` (object)

  - `nice.rrn` (string)

  - `nice.address` (string)

  - `nice.address_oneline` (string)

  - `nice.address.country` (string)

  - `nice.address.country:raw` (string)

  - `nice.address.city` (string)

  - `nice.address.region` (string)

  - `nice.address.region:raw` (string)

  - `nice.address.postcode` (string)

  - `nice.address.street_address_1` (string)

  - `nice.address.street_address_2` (string)

  - `nice.address.street_address_3` (string)

  - `nice.address.latitude` (string)

  - `nice.address.longitude` (string)

  - `nice.created_at` (string)

  - `nice.created_at__date` (string)

  - `nice.created_at__time` (string)

  - `nice.created_at__offset` (string)

  - `nice.created_at__offset_minutes` (integer)

  - `nice.created_at__dayofweek` (string)

  - `nice.end_timestamp` (string)

  - `nice.end_timestamp__date` (string)

  - `nice.end_timestamp__time` (string)

  - `nice.end_timestamp__offset` (string)

  - `nice.end_timestamp__offset_minutes` (integer)

  - `nice.end_timestamp__dayofweek` (string)

  - `nice.event_shift_template_id` (string | null)

  - `nice.event_shift_template_id:value` (string | null)

  - `nice.event_shift_template_id:array` (string | null)

  - `nice.event_shift_type_id` (string | null)

  - `nice.event_shift_type_id:value` (string | null)

  - `nice.event_shift_type_id:array` (string | null)

  - `nice.headcount_location_venue_id` (string | null)

  - `nice.headcount_location_venue_id:value` (string | null)

  - `nice.headcount_location_venue_id:array` (string | null)

  - `nice.is_virtual` (string)

  - `nice.minimum_age` (string)

  - `nice.name` (string)

  - `nice.no_shift_time` (string)

  - `nice.post_feedback_form` (string | null)

  - `nice.post_feedback_form:value` (string | null)

  - `nice.post_feedback_form:array` (string | null)

  - `nice.public` (string)

  - `nice.publish` (string)

  - `nice.role_offer_address` (string)

  - `nice.role_offer_id` (string | null)

  - `nice.role_offer_id:value` (string | null)

  - `nice.role_offer_id:array` (string | null)

  - `nice.self_checkin` (string)

  - `nice.shift_application_form_id` (string | null)

  - `nice.shift_application_form_id:value` (string | null)

  - `nice.shift_application_form_id:array` (string | null)

  - `nice.shift_attended_form_id` (string | null)

  - `nice.shift_attended_form_id:value` (string | null)

  - `nice.shift_attended_form_id:array` (string | null)

  - `nice.shift_checkin_form_id` (string | null)

  - `nice.shift_checkin_form_id:value` (string | null)

  - `nice.shift_checkin_form_id:array` (string | null)

  - `nice.shift_checkout_form_id` (string | null)

  - `nice.shift_checkout_form_id:value` (string | null)

  - `nice.shift_checkout_form_id:array` (string | null)

  - `nice.shift_precheckin_form_id` (string | null)

  - `nice.shift_precheckin_form_id:value` (string | null)

  - `nice.shift_precheckin_form_id:array` (string | null)

  - `nice.shift_withdraw_form_id` (string | null)

  - `nice.shift_withdraw_form_id:value` (string | null)

  - `nice.shift_withdraw_form_id:array` (string | null)

  - `nice.start_timestamp` (string)

  - `nice.start_timestamp__date` (string)

  - `nice.start_timestamp__time` (string)

  - `nice.start_timestamp__offset` (string)

  - `nice.start_timestamp__offset_minutes` (integer)

  - `nice.start_timestamp__dayofweek` (string)

  - `nice.updated_at` (string)

  - `nice.updated_at__date` (string)

  - `nice.updated_at__time` (string)

  - `nice.updated_at__offset` (string)

  - `nice.updated_at__offset_minutes` (integer)

  - `nice.updated_at__dayofweek` (string)

  - `nice.visibility_hide_groups` (string)

  - `nice.visibility_show_groups` (string)

  - `nice.visibility_show_roleoffer` (string)

  - `nice.info` (string)

  - `nice.event_shift_link_id` (integer)

  - `nice.event_shift_link_repeat` (integer)

  - `nice.event_shift_link_name` (string)

  - `nice.shift_status_default_id` (integer)

  - `nice.length` (integer)

  - `nice.account_id` (integer)

  - `nice.account_url` (string)

  - `nice.is_any_leader` (boolean)

  - `nice.post_shift_feedback_form_completed_at` (string)

  - `nice.pre_checkin_form_completed_at` (string)

  - `nice.event_name` (string | null)

  - `relations` (array)

  - `permissions` (object)

  - `permissions.read` (boolean)

  - `permissions.update` (boolean)

  - `permissions.delete` (boolean)

  - `permissions.apply` (boolean)

  - `permissions.apply_error` (string)

  - `permissions.apply_error_code` (string)

  - `permissions.is_unavailable` (boolean)

  - `permissions.confirm` (boolean)

  - `permissions.reject` (boolean)

  - `permissions.selfCheckin` (boolean)

  - `permissions.selfCheckout` (boolean)

  - `permissions.submitAttendedForm` (boolean)

  - `permissions.precheckin` (boolean)

  - `permissions.applyWaitlist` (boolean)

  - `attributes` (object)