Event

Get user event by id

Info

Required scopes: stream.read

Warning

This method requires authentication

Retrieve a user event by id.

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/events/2527849f-f961-4b1d-8ae0-8eae4f068327

Response

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

isRecordOnly is true if the event is/was streamed in a record-only mode. Timestamps are in seconds and can be null.