Searches for teaching events.

Searches for teaching events. Optionally limit the results by distance (in miles) from a postcode, event type and start date.

Postcodestring nullable

Postcode to center search around.

Radiusinteger nullable

Set to filter results to a radius (in miles) around the postcode.

TypeIdsinteger[] nullable

Set to filter results to a type of teaching event. Each ID must match a typeId of the TeachingEvent schema.

Onlineboolean nullable

Set to true to return only online events and false to return only in-person events.

StartAfterstring date-time nullable

Set to filter results to those that start after a given date.

StartBeforestring date-time nullable

Set to filter results to those that start before a given date.

StatusIdsinteger[] nullable

Set to filter results by event status.

AccessibilityOptionsinteger[] nullable

Set to filter results by accessibility options.

quantityinteger

Quantity to return.

Response

OK

idstring uuid nullable

typeIdinteger

statusIdinteger

regionIdinteger nullable

readableIdstring required

webFeedIdstring nullable

If set, the API will accept new attendees for this event (an external sign up should be used if this value is nil).

isOnlineboolean

namestring required

summarystring nullable

messagestring nullable

Used to push miscellaneous messages to users (if an event is close to being booked out, for example).

descriptionstring nullable

videoUrlstring nullable

scribbleIdstring nullable

providerWebsiteUrlstring nullable

providerTargetAudiencestring nullable

providerOrganiserstring nullable

providerContactEmailstring email nullable

startAtstring date-time

endAtstring date-time

providersListstring nullable

isVirtualboolean

accessibilityOptionsinteger[] nullable

isInPersonboolean

v1

Searches for teaching events.

Query parameters

Response