# List my events

Returns the events the signed-in user has a record against - anything they have applied
for, been rostered onto, attended or registered interest in. An event the user has no
involvement with is never returned, so this is the volunteer's own history and upcoming
schedule rather than a catalogue of what the organisation is running.
Rows are events, not shifts. To work with the individual shifts inside an event, use the
shift endpoints rather than reading them from here.
Events that have not been published are excluded unless the caller also administers events,
so an ordinary portal user and an administrator can get different counts for the same
query.
The listing is only paginated when `page` is supplied. Without it every match is returned
as a flat array rather than in the paged envelope.

Endpoint: GET /api/v2/me/event
Version: 2.0.0
Security: default

## Query parameters:

  - `status` (string)
    Narrow the list by the user's involvement. `active` returns only
  events where they hold a live place, `demand` only events still looking for people. Any
  other value is ignored and the full list is returned.

  - `per_page` (integer)
    The number of results to return per page. The higher the number the longer the request may take.
It is highly recommended to use this to avoid timeouts as your data grows.
Used in conjunction with the `page` parameter to paginate results.

  - `page` (integer)
    The page of results to return. Used in conjunction with the `per_page` parameter to paginate
results. If not specified, defaults to 1.
The response's next_page_url will be null if there are no
more pages.

  - `filter` (array)
    A filter to apply to the results. Declared as an array of objects, where each object
contains an attr (attribute code), operator and value key. Examples:

?filter[0]['attr']=name&filter[0][operator]=like&filter[0][value]=luke 

?filter[0]['attr']=id&filter[0][operator]=>&filter[0][value]=265 

See the filters documentation for more details on how to use this.

  - `sort_by` (string)
    The field to sort the results by. No ordering is applied unless you specify one, so
row order is not guaranteed. Always send it when paging through a list, otherwise
records can repeat or be missed between pages.
Example: id

  - `sort_order` (string)
    The direction to sort the results by. Can be 'asc' or 'desc', default is 'asc'.

  - `_locale` (string)
    The locale to use for the response. This primarily affects the results of the `nice` field, which
contain human-readable labels and terms, as well as locale-specific date formats.,

  - `extras` (array)
    A list of extras to include in the response. These are objects or arrays that are not part of
the model's primary attributes, such as stats and counts.
For fast responses, avoid requesting them if you don't need them.

  - `with` (array)
    A list of relations to include in the response. May be single records or collections.
It is often more efficient to retrieve this way, to avoid follow-up API calls.

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `current_page` (integer)

  - `data` (array)

  - `data.object` (object)

  - `data.object.id` (integer)

  - `data.object.parent_id` (string | null)

  - `data.object.event_template_id` (string | null)

  - `data.object.path` (string)

  - `data.object.account_id` (integer)

  - `data.object.event_type_id` (integer)

  - `data.object.journey_id` (string | null)

  - `data.object.timezone` (string)

  - `data.object.start_timestamp` (string)

  - `data.object.end_timestamp` (string)

  - `data.object.is_ongoing` (integer)

  - `data.object.apps_open_timestamp` (string)

  - `data.object.apps_close_timestamp` (string)

  - `data.object.headcount_location_venue_id` (string | null)

  - `data.object.headcount_functional_area_job_title_id` (string | null)

  - `data.object.shift_status_default` (integer)

  - `data.object.max_shift_apps_per_user` (integer)

  - `data.object.min_shift_apps_per_user` (integer)

  - `data.object.min_shift_apps_per_shift_type` (string | null)

  - `data.object.max_shift_apps_per_shift_type` (string | null)

  - `data.object.gap_between_shifts` (integer)

  - `data.object.shift_confirmed_status_default` (integer)

  - `data.object.shift_rejected_status_default` (integer)

  - `data.object.shift_can_withdraw_default` (integer)

  - `data.object.shift_can_confirm_default` (integer)

  - `data.object.shift_can_confirm_limit` (integer)

  - `data.object.shift_can_withdraw_limit` (integer)

  - `data.object.shift_checked_in_status_default` (integer)

  - `data.object.shift_checked_out_status_default` (integer)

  - `data.object.certificate_id` (string | null)

  - `data.object.shift_application_form_id_default` (string | null)

  - `data.object.shift_withdraw_form_id_default` (string | null)

  - `data.object.shift_checkin_form_id_default` (string | null)

  - `data.object.shift_attended_form_id_default` (string | null)

  - `data.object.shift_checkout_form_id_default` (string | null)

  - `data.object.shift_leader_feedback_form_id_default` (string | null)

  - `data.object.shift_feedback_form_id_default` (string | null)

  - `data.object.shift_precheckin_form_id_default` (string | null)

  - `data.object.shift_default_journey_complete_status` (string | null)

  - `data.object.shift_default_journey_id` (string | null)

  - `data.object.allow_user_activities` (integer)

  - `data.object.user_activity_form_id` (string | null)

  - `data.object.training_ids` (string | null)

  - `data.object.banner_image` (string | null)

  - `data.object.grid_image` (string | null)

  - `data.object.minimum_dob` (string | null)

  - `data.object.minimum_age` (string | null)

  - `data.object.maximum_dob` (string | null)

  - `data.object.maximum_age` (string | null)

  - `data.object.visibility_show_groups` (array)

  - `data.object.visibility_hide_groups` (array)

  - `data.object.visibility_show_roleoffer` (array)

  - `data.object.role_offer_address` (integer)

  - `data.object.checkin_visible_attributes` (array)

  - `data.object.shift_filter_attributes` (string | null)

  - `data.object.leader_shift_filter_attributes` (string | null)

  - `data.object.self_checkin` (integer)

  - `data.object.self_checkin_open` (integer)

  - `data.object.self_checkin_close` (integer)

  - `data.object.self_checkout_close` (integer)

  - `data.object.checkin_close_default` (integer)

  - `data.object.shift_precheckin_open_default` (string | null)

  - `data.object.shift_enable_waitlist_default` (integer)

  - `data.object.geofence_checkin_limit_default` (string | null)

  - `data.object.max_waitlist` (integer)

  - `data.object.group_booking_ttl_default` (string | null)

  - `data.object.max_group_demand_default` (string | null)

  - `data.object.max_group_size` (string | null)

  - `data.object.reserved_expiry` (string | null)

  - `data.object.post_feedback_form` (string | null)

  - `data.object.post_feedback_publish_at` (string | null)

  - `data.object.expression_of_interest` (integer)

  - `data.object.journey_complete_status` (string | null)

  - `data.object.journey_apply_status` (string | null)

  - `data.object.expression_of_interest_form` (string | null)

  - `data.object.cancel_expression_of_interest_form_id` (string | null)

  - `data.object.eoi_demand` (integer)

  - `data.object.sort_order` (integer)

  - `data.object.is_virtual` (integer)

  - `data.object.status` (string)

  - `data.object.approval_status` (string)

  - `data.object.approval_reason` (string | null)

  - `data.object.promoted` (integer)

  - `data.object.public` (integer)

  - `data.object.is_cancelled` (integer)

  - `data.object.is_archived` (integer)

  - `data.object.public_shift` (integer)

  - `data.object.public_shift_default` (integer)

  - `data.object.certificates_awarded` (integer)

  - `data.object.created_by` (integer)

  - `data.object.updated_by` (integer)

  - `data.object.deleted_at` (string | null)

  - `data.object.is_erased` (integer)

  - `data.object.created_at` (string)

  - `data.object.updated_at` (string)

  - `data.object.deleted_by` (string | null)

  - `data.object.description` (string)

  - `data.object.name` (string)

  - `data.object.address` (object)

  - `data.object.address.iso` (string)

  - `data.object.address.street_address_1` (string)

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

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

  - `data.object.address.city` (string)

  - `data.object.address.postcode` (string)

  - `data.object.address.region` (string)

  - `data.object.address.country` (string)

  - `data.object.address.latitude` (string | null)

  - `data.object.address.longitude` (string | null)

  - `data.nice` (object)

  - `data.nice.rrn` (string)

  - `data.nice.allow_user_activities` (string)

  - `data.nice.approval_status` (string)

  - `data.nice.approval_status:value` (string)

  - `data.nice.approval_status:array` (string)

  - `data.nice.apps_close_timestamp` (string)

  - `data.nice.apps_close_timestamp__date` (string)

  - `data.nice.apps_close_timestamp__time` (string)

  - `data.nice.apps_close_timestamp__offset` (string)

  - `data.nice.apps_close_timestamp__offset_minutes` (integer)

  - `data.nice.apps_close_timestamp__dayofweek` (string)

  - `data.nice.apps_open_timestamp` (string)

  - `data.nice.apps_open_timestamp__date` (string)

  - `data.nice.apps_open_timestamp__time` (string)

  - `data.nice.apps_open_timestamp__offset` (string)

  - `data.nice.apps_open_timestamp__offset_minutes` (integer)

  - `data.nice.apps_open_timestamp__dayofweek` (string)

  - `data.nice.cancel_expression_of_interest_form_id` (string | null)

  - `data.nice.cancel_expression_of_interest_form_id:value` (string | null)

  - `data.nice.cancel_expression_of_interest_form_id:array` (string | null)

  - `data.nice.created_at` (string)

  - `data.nice.created_at__date` (string)

  - `data.nice.created_at__time` (string)

  - `data.nice.created_at__offset` (string)

  - `data.nice.created_at__offset_minutes` (integer)

  - `data.nice.created_at__dayofweek` (string)

  - `data.nice.end_timestamp` (string)

  - `data.nice.end_timestamp__date` (string)

  - `data.nice.end_timestamp__time` (string)

  - `data.nice.end_timestamp__offset` (string)

  - `data.nice.end_timestamp__offset_minutes` (integer)

  - `data.nice.end_timestamp__dayofweek` (string)

  - `data.nice.event_template_id` (string | null)

  - `data.nice.event_template_id:value` (string | null)

  - `data.nice.event_template_id:array` (string | null)

  - `data.nice.event_type_id` (string)

  - `data.nice.event_type_id:value` (integer)

  - `data.nice.event_type_id:array` (string)

  - `data.nice.expression_of_interest` (string)

  - `data.nice.headcount_location_venue_id` (string | null)

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

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

  - `data.nice.is_ongoing` (string)

  - `data.nice.is_virtual` (string)

  - `data.nice.name` (string)

  - `data.nice.promoted` (string)

  - `data.nice.role_offer_address` (string)

  - `data.nice.self_checkin` (string)

  - `data.nice.shift_application_form_id_default` (string | null)

  - `data.nice.shift_application_form_id_default:value` (string | null)

  - `data.nice.shift_application_form_id_default:array` (string | null)

  - `data.nice.shift_attended_form_id_default` (string | null)

  - `data.nice.shift_attended_form_id_default:value` (string | null)

  - `data.nice.shift_attended_form_id_default:array` (string | null)

  - `data.nice.shift_checkin_form_id_default` (string | null)

  - `data.nice.shift_checkin_form_id_default:value` (string | null)

  - `data.nice.shift_checkin_form_id_default:array` (string | null)

  - `data.nice.shift_checkout_form_id_default` (string | null)

  - `data.nice.shift_checkout_form_id_default:value` (string | null)

  - `data.nice.shift_checkout_form_id_default:array` (string | null)

  - `data.nice.shift_feedback_form_id_default` (string | null)

  - `data.nice.shift_feedback_form_id_default:value` (string | null)

  - `data.nice.shift_feedback_form_id_default:array` (string | null)

  - `data.nice.shift_precheckin_form_id_default` (string | null)

  - `data.nice.shift_precheckin_form_id_default:value` (string | null)

  - `data.nice.shift_precheckin_form_id_default:array` (string | null)

  - `data.nice.shift_withdraw_form_id_default` (string | null)

  - `data.nice.shift_withdraw_form_id_default:value` (string | null)

  - `data.nice.shift_withdraw_form_id_default:array` (string | null)

  - `data.nice.start_timestamp` (string)

  - `data.nice.start_timestamp__date` (string)

  - `data.nice.start_timestamp__time` (string)

  - `data.nice.start_timestamp__offset` (string)

  - `data.nice.start_timestamp__offset_minutes` (integer)

  - `data.nice.start_timestamp__dayofweek` (string)

  - `data.nice.status` (string)

  - `data.nice.status:value` (string)

  - `data.nice.status:array` (string)

  - `data.nice.tags` (string | null)

  - `data.nice.tags:value` (string | null)

  - `data.nice.tags:array` (string | null)

  - `data.nice.updated_at` (string)

  - `data.nice.updated_at__date` (string)

  - `data.nice.updated_at__time` (string)

  - `data.nice.updated_at__offset` (string)

  - `data.nice.updated_at__offset_minutes` (integer)

  - `data.nice.updated_at__dayofweek` (string)

  - `data.nice.visibility_hide_groups` (string)

  - `data.nice.visibility_show_groups` (string)

  - `data.nice.visibility_show_roleoffer` (string)

  - `data.nice.full_name` (string)

  - `data.nice.event_type_name` (string)

  - `data.nice.grid_list_image` (string | null)

  - `data.nice.is_eoi_demand_met` (boolean)

  - `data.nice.has_payrun` (boolean)

  - `data.nice.min_shifts` (integer)

  - `data.nice.post_event_feedback_form_completed_at` (string | null)

  - `data.nice.expression_of_interest_form_completed_at` (string | null)

  - `data.nice.expression_of_interest_form_cancelled_at` (string | null)

  - `data.nice.account_name` (string)

  - `data.nice.apply` (object)

  - `data.nice.apply.code` (integer)

  - `data.nice.apply.message` (string)

  - `data.nice.address` (string)

  - `data.nice.address_oneline` (string)

  - `data.nice.address.latitude` (string | null)

  - `data.nice.address.longitude` (string | null)

  - `data.relations` (array)

  - `data.permissions` (object)

  - `data.permissions.read` (boolean)

  - `data.permissions.update` (boolean)

  - `data.permissions.delete` (boolean)

  - `data.permissions.apply` (boolean)

  - `data.permissions.cancel` (boolean)

  - `data.permissions.can_publish` (boolean)

  - `data.attributes` (array)

  - `first_page_url` (string)

  - `from` (integer)

  - `next_page_url` (string)

  - `path` (string)

  - `per_page` (integer)

  - `prev_page_url` (string | null)

  - `to` (integer)