Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Events

GET a collection of events.

Retrieve a collection of events with event details.

get/events

Query parameters

event_statusstring

Use to return only events that meet the specified status. Acceptable values include ACTIVE,DRAFT, COMPLETE, DELETED,CANCELLED, and ERROR.

search_textstring

Use to return only events that include the specified text.

sort_bystring

Use to sort resulting events by one of the following properties: name, start_time, end_time, created_time, or updated_time.

sort_orderstring

Sort order for the sort_by parameter. Accepted values include ASC (ascending) or DESC (descending). Defaults to ASC if sort_by is provided.

limitstring

Limit the number of results to return per page. Default and maximum is 100.

prevstring

Cursor for retrieving the previous page of results. This value is obtained from the prev_cursor field in a previous response.

nextstring

Cursor for retrieving the next page of results. This value is obtained from the next_cursor field in a previous response.

Response

Request Successful

total_recordsinteger

The total number of events across all pages.

next_cursorstring

Use to get the next page of results.

prev_cursorstring

Use to get the previous page of results.

Example response

{
  "records": [
    {
      "event_id": "05cf4d60-56ea-4023-bf49-b35e56a9c7b5",
      "title": "Class of 2015 Reunion",
      "description": "Join us for a night of reminiscing and celebration!",
      "start_time": "2023-12-01T20:30:00Z",
      "end_time": "2023-12-01T21:30:00Z",
      "status": "ACTIVE",
      "registration_url": "https://sample_url.com/ev/reg/scrk2u2",
      "name": "Holiday Market at Snowport",
      "event_type": "PERFORMING_ARTS",
      "location_type": "PHYSICAL",
      "time_zone_type": "EST",
      "address": {
        "address_type": "EVENT",
        "line1": "100 Seaport Blvd",
        "line2": "100 Seaport Blvd",
        "city": "Boston",
        "country": "United States",
        "country_code": "US",
        "create_time": "2023-11-17T17:33:21.652Z",
        "last_update_time": "2023-12-07T13:18:39.681Z",
        "latitude": 42.629368,
        "longitude": -71.27594,
        "location_name": "Holiday Market at Snowport",
        "postal_code": "02451",
        "state": "Queensland",
        "state_code": "MA"
      },
      "create_time": "2023-09-01T20:30:00Z"
    }
  ],
  "total_records": 26,
  "next_cursor": "roBvv-Nidkuxg8gTAJ5joDU6yQufWMDdEHjRqzcTXnZ3qBZYR3jZChnZTC6McJ6j8M70fM4IFT8KNJvA076D0g",
  "prev_cursor": "Z83W2HtZsQkzXXStyKDDKs5hkuPz7mQvqcg37Quq-Lb_BXnKqYmUf13Li6ZyeRCY8M70fM4IFT8KNJvA076D0g"
}