GET
/
activity
/
sessions
/
{workspaceId}
cURL
curl --request GET \
  --url https://api.hyra.io/activity/sessions/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "permissions": {
    "self_assign_host": true,
    "assign_host": true,
    "self_assign_cohost": true,
    "assign_cohost": true,
    "assign_roles": true,
    "create_report": true,
    "host_quota": 123,
    "cohost_quota": 123,
    "host_quota_used": 123,
    "cohost_quota_used": 123,
    "delete_sessions": true,
    "delete_adhoc_sessions": true,
    "cancel_sessions": true,
    "create_adhoc_sessions": true
  },
  "events": [
    {
      "_id": "<string>",
      "schedule": {
        "_id": "<string>",
        "name": "<string>",
        "public_start_offset": 123,
        "public_slock_offset": 123,
        "publish_to_discord": true,
        "game_link": "<string>",
        "thumbnail_url": "<string>",
        "roles": [
          "<string>"
        ],
        "updatedAt": "2023-11-07T05:31:56Z",
        "game_thumbnail_url": "<string>",
        "disable_cohost": true
      },
      "servers": [
        {
          "_id": "<string>",
          "source": "web",
          "groups": [
            {
              "_id": "<string>",
              "priority": 123,
              "name": "<string>",
              "roles": [
                {
                  "_id": "<string>",
                  "user_id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          ],
          "created_by": "<string>",
          "status": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "start": "2023-11-07T05:31:56Z",
      "in_progress": true,
      "cancelled": false,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "adhoc": false,
      "host_id": "<string>",
      "host": {
        "exists": true,
        "id": "<string>",
        "username": "<string>",
        "display_name": "<string>"
      },
      "co_host_id": "<string>",
      "co_host": {
        "exists": true,
        "id": "<string>",
        "username": "<string>",
        "display_name": "<string>"
      },
      "polyfill": [
        {
          "_id": "<string>",
          "name": "<string>",
          "roles": [
            {
              "_id": "<string>",
              "name": "<string>"
            }
          ],
          "priority": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "subhosting": [
        {
          "server_id": "<string>",
          "type": "host_id",
          "user_id": "<string>",
          "user": {
            "exists": true,
            "id": "<string>",
            "username": "<string>",
            "display_name": "<string>"
          }
        }
      ]
    }
  ],
  "week_starts_on": "sunday"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Socket-Id
string

Path Parameters

workspaceId
string
required

Query Parameters

day
string

Day to get sessions for (deprecated)

start_date
string

Start date to get sessions for

end_date
string

End date to get sessions for

attendee
string

User ID of the attendee

Response

200 - application/json

Default Response

The response is of type object.