Sign in

v1

latestOpenAPI 3.0.0http://www.apache.org/licenses/LICENSE-2.0.html2026-07-14543167.2 KB
events

Get an event

get/events/{eventID}

Path parameters

eventIDstring uuid required

Response

Successful response

idstring uuid
namestring

The Heartbeat event name

descriptionstring

The event description

startTimestring date-time

The original start time for the event in UTC. If this event is recurring, this might be in the past.

endTimestring date-time

The original end time for the event in UTC. If this event is recurring, this may be in the past.

recurringboolean

Whether the event is recurring.

createdAtstring date-time

The date and time in UTC at which the event was created.

createdBystring uuid

The user id of the person that created the event

invitedUsersstring[]

The users that are invited to this event

invitedGroupsstring[]

The groups that are invited to this event

coverImagestring nullable

URL of the event cover image. Null if no image is set.

Example response

{
  "name": "Toby's Going-Away Party",
  "description": "The best event to happen this year. Look forward to fireworks and BBQ!",
  "recurring": true,
  "coverImage": "https://example.com/event-cover.jpg"
}