Get upcoming sessions

The next sessions from today (limit=, days=).

GET /get-upcoming-sessions

Get upcoming sessions

cURL

curl --request GET \
  --url https://api.lumonol.co.uk/ankra/get-upcoming-sessions \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Training",
    "date": "2023-12-25",
    "start_time": "19:00:00",
    "status": "scheduled",
    "is_adhoc": true,
    "game_link": "<string>",
    "banner_url": "<string>"
  }
]

Authorizations

Authorization · string · header · required

A workspace API key from Settings › Developer.

Query Parameters

workspace_id · string · required

The workspace: the 24-character ID in its Ankra address, or its UUID.

limit · integer · default: 10

How many to return, up to 100.

Required range: 1 <= x <= 100

days · integer · default: 30

How far ahead to look.

Required range: 1 <= x <= 92

Response

200

application/json

OK.

event_id · string<uuid> | null

Null until someone acts on the session.

schedule_id · string<uuid>

name · string

Example:

"Training"

date · string<date>

start_time · string

Example:

"19:00:00"

status · enum<string>

Available options: scheduled, cancelled

is_adhoc · boolean

game_link · string | null

banner_url · string | null