Skip to content
API reference
/
/
List my events

List my events

Request

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.

Security
default
Query
statusstring

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_pageinteger

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.

pageinteger

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.

filterArray of objects

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_bystring

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_orderstring

The direction to sort the results by. Can be 'asc' or 'desc', default is 'asc'.

Enum:"asc""desc"
_localestring

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.,

extrasArray of strings

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.

Items Enum:"leader_state""shift_count""stats""certificate_user_count"
withArray of strings

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.

Items Enum:"hasManyDeepFromRelationsWithConstraints""hasOneDeepFromRelationsWithConstraints""hasManyDeepFromReverse""hasOneDeepFromReverse"
Headers
Rosterfy-Platformstring
curl -i -X GET \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/me/event?status=active&per_page=5&page=1&filter=%7Bfilter%7D&sort_by=%7Bsort_by%7D&sort_order=%7Bsort_order%7D&_locale=en-US&extras=leader_state&with=hasManyDeepFromRelationsWithConstraints' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Successful response

Bodyapplication/json
Array [
current_pageinteger
dataArray of objects
first_page_urlstring
frominteger
next_page_urlstring
pathstring
per_pageinteger
prev_page_urlstring or null
tointeger
]
Response
[
  {
    "current_page": 1,
    "data": [ … ],
    "first_page_url": "https://example.rosterfy.com/api/v2/me/event?per_page=5&_locale=en-US&page=1",
    "from": 1,
    "next_page_url": "https://example.rosterfy.com/api/v2/me/event?per_page=5&_locale=en-US&page=2",
    "path": "https://example.rosterfy.com/api/v2/me/event",
    "per_page": 5,
    "prev_page_url": null,
    "to": 5
  }
]