Get all events within a specified date range

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Filter events using a Base64-encoded JSON object.

The filters query parameter is required.

Choose the fields below, serialize the object to JSON, and Base64-encode the UTF-8 bytes. Enter the encoded value in the filters input. These fields belong inside the JSON object; they are not separate query parameters.

Decoded filter fields

FieldTypeDescription
timeRangeobjectFilters events by time range. All event start dates will be on or after start, and all end dates will be on or before end.
timeRange.startstringStart date and time for the events. Format: rfc3339Timestamp.
timeRange.endstringEnd date and time for the events. Format: rfc3339Timestamp.
organizersarray of stringsFilters events by organizer userIds. Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439011"].
attendeesarray of stringsFilters events by attendee userIds. Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439011"].
otherAttendeesarray of stringsFilters events by otherAttendee userIds. Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439011"].
sitesarray of stringsFilter by site Each item: mongodb id (12 byte hex string). Example: ["507f1f77bcf86cd799439011"].
customAttributesarray of stringsFilter by event custom attributes Example: ["NydvLFSpxOJe2aO07hGxU"].

Example before encoding

{
  "timeRange": {
    "start": "2024-06-30T01:00:00.000Z",
    "end": "2024-07-30T23:59:00.000Z"
  }
}

Base64 value for the filters input

eyJ0aW1lUmFuZ2UiOnsic3RhcnQiOiIyMDI0LTA2LTMwVDAxOjAwOjAwLjAwMFoiLCJlbmQiOiIyMDI0LTA3LTMwVDIzOjU5OjAwLjAwMFoifX0=

Example request

/events?filters=eyJ0aW1lUmFuZ2UiOnsic3RhcnQiOiIyMDI0LTA2LTMwVDAxOjAwOjAwLjAwMFoiLCJlbmQiOiIyMDI0LTA3LTMwVDIzOjU5OjAwLjAwMFoifX0%3D

Encode inline in Node.js

const criteria = {"timeRange":{"start":"2024-06-30T01:00:00.000Z","end":"2024-07-30T23:59:00.000Z"}};
const params = new URLSearchParams({
  filters: Buffer.from(JSON.stringify(criteria), "utf8").toString("base64")
});
const path = "/events?" + params.toString();

Base64 encoding and URL encoding are separate steps. An HTTP client query-parameter helper can URL-encode the Base64 value for you. If constructing the URL manually, URL-encode the value once so +, /, and = are preserved.

integer

Number of events per page

integer

Page number to retrieve

Responses

500

Internal server error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json