Get all events

This endpoint retrieves a paginated list of all events for your school.

What this endpoint does:

  • Supports various filtering options to find specific events
  • Returns paginated results to handle large datasets efficiently
  • Can return either full event details or lightweight data for performance

Date filtering behavior: The start/end filters work based on the event's start date.

Filtering options:

  • If both start and end are provided: returns events that start between these two dates (inclusive)
  • If only start is provided: returns events that start on or after this date
  • If only end is provided: returns events that start on or before this date

⚠️ Important: The school's timezone is automatically used when applying date filters to ensure accurate date comparisons.

Light mode: Use the 'light' parameter when you only need basic event information for lists or dropdowns, which improves loading speed.

Query Params
string
required

Query param for pagination, starts at page "1" and displays events per page (default: 1)

string

Maximum number of events to return per page (default and max: 1000)

string

Filter events starting from this date (format: YYYY-MM-DD, ISO 8601)

string

Filter events ending before this date (format: YYYY-MM-DD, ISO 8601)
Note: When both start and end dates are provided, events will be filtered to include only those occurring within this date range.

string

Show only events assigned to this specific student (use internal Edusign student ID)

string

Show only events assigned to this specific professor (use internal Edusign professor ID)

string

Filter events by external API IDs (JSON array as string, e.g., '["api1","api2"]')

string

When set to true, returns simplified event data with only id, name, apiId, and apiType fields for faster loading

Response

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