Events Resources | Upcoach Developer Portal

Endpoints

GET

https://api.upcoach.com/events

List events

Returns a list of events

Parameters

Query

filter[program] *

Program ID

filter[status]

string, either past or upcoming . Default value is upcoming

page_date

Y-m-d H:i formatted date string, determines when to start the pagination from. If status is past , events are listed in descending order based on their date and time.

Responses

200: OK

A paginated list of Event Resource Objects. You can use the next param value to retrieve the next page of events.

{
    "data": [
      {
        "id": "...",
        "title": "...",                           },
    ...
  ],
  "links": {
    "next": "..."
  },
}

Resource Objects

Event

Property	Type	Description
id	string	Event ID
title	string	Title
description	string	Description
color	string\|null	Color
duration	string	Duration in human readable format
start_hour	string	Start hour
end_hour	string	End hour
start_date	string	Start date
end_date	string	End date
call_url	string\|null	Video call URL
meeting_url	string\|null	Meeting URL (for notes, agenda, ...)
thumbnail	string\|null	Image URL
pattern	string\|null	Recurring event pattern
custom_pattern	string\|null	Custom recurring event pattern, if available
event_timezone	string	Event timezone