Skip to main content

Get List of All Events

Gets a list of all created events.

Authorizations: Sessions - VIEW

Requests

CODE
GET /apis/events

Tip

You can query events based on a title and description (or HotMark title and description) by adding the “q” query parameter to the collection URL. For more information, see Queries.

Response

Success

CODE
{
  "data": [{
    "moduleId": "ccf00271-adda-42b4-895f-bb54338fb932",
    "module": "session",
    "startTime": 1592344800,
    "duration": 7200,
    "type": "weekly-recurring",
    "typeData": {"days": ["MON","WED","SAT"]},
    "command": "set-live",
    "parameters": {"record": true},
    "active": true,
    "id": "e808eb59-00c4-4a2e-a0e1-b06a693c7736",
    "title": "Test Session"
  }],
  "paging": {
    "results": 1,
    "pageSize": 15
  }
}

Error

Code

Payload

 Description

404

{"code": "040012", "name":"NoResults",
"message":"No results", "httpStatusCode":404}

No results returned from the server.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.