List sessions

Sessions between start_date and end_date (up to 92 days).

Generated from the session types, so sessions nobody has acted on have no event_id yet.

GET /list-sessions

List sessions

cURL

curl --request GET \
  --url https://api.lumonol.co.uk/ankra/list-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.

start_date · string<date>

The first day. Defaults to today (UTC).

end_date · string<date>

The last day, up to 92 days on. Defaults to start_date.

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