Upcoming Events

List of user's events

Info

Required scopes: stream.read

Warning

This method requires authentication

Retrieve a list of the user's events.

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/events/upcoming

Query Parameters:

ParameterTypeDescription
sourceintegerFilter events by source type (1 - Studio, 2 - Encoder, 3 - Video)
scheduledbooleanWhen true, returns only scheduled events

Example request:

curl -H "Authorization: Bearer [access token]" \
     "https://api.restream.io/v2/user/events/upcoming?source=1&scheduled=true"

Response

Success
Error
[
  {
    "id": "2527849f-f961-4b1d-8ae0-8eae4f068327",
    "status": "upcoming",
    "title": "Event title",
    "description": "Event description",
    "coverUrl": "URL or null",
    "scheduledFor": 1599983310,
    "startedAt": null,
    "finishedAt": null,
    "destinations": [
      {
        "channelId": 1,
        "externalUrl": "URL or null",
        "streamingPlatformId": 5
      }
    ]
  },
  ...
]