Workspace
Retrieve Schedules
API Documentation
Activity
- In-Game Tracking
- Users
- Sessions
- GETRetrieve Leaderboard
Order Logging
Staff
Workspace
- GETRetrieve a Workspace
- POSTUpdate a Workspace
- GETList Games
- POSTCreate Game
- DELDelete a Game
- GETList Roles
- POSTCreate a Role
- PUTUpdate Role
- DELDelete a Role
- GETList logbook templates
- GETRetrieve Logbook Template
- POSTCreate a Logbook Template
- PATCHUpdate a Logbook Template
- DELDelete a Logbook Template
- GETRetrieve GApps Config
- POSTSet GApps Service Account
- PATCHUpdate GApps Config
- DELDelete GApps Config
- GETGet Trello Config
- GETGet Trello boards
- POSTSet Trello board
- POSTSet Trello format
- DELDisconnect Trello board
- DELDelete Trello Config
- GETRetrieve Schedules
- POSTCreate a Schedule
- POSTUpdate a Schedule
Trello Integration
Bans (Invite Only)
Connections
Workspace
Retrieve Schedules
GET
/
workspace
/
sessions
/
{workspaceId}
curl --request GET \
--url https://api.hyra.io/workspace/sessions/{workspaceId} \
--header 'Authorization: Bearer <token>'
{
"schedules": [
{
"_id": "<string>",
"name": "<string>",
"external_description": "<string>",
"public_start_offset": 123,
"public_slock_offset": 123,
"series_start_date": "2023-11-07T05:31:56Z",
"game_link": "<string>",
"publish_to_discord": true,
"roles": [
"<string>"
],
"disable_cohost": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reoccurring": true,
"cron_expression": "<string>"
}
],
"groups": [
{
"_id": "<string>",
"name": "<string>",
"roles": [
{
"_id": "<string>",
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
Default Response
curl --request GET \
--url https://api.hyra.io/workspace/sessions/{workspaceId} \
--header 'Authorization: Bearer <token>'
{
"schedules": [
{
"_id": "<string>",
"name": "<string>",
"external_description": "<string>",
"public_start_offset": 123,
"public_slock_offset": 123,
"series_start_date": "2023-11-07T05:31:56Z",
"game_link": "<string>",
"publish_to_discord": true,
"roles": [
"<string>"
],
"disable_cohost": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reoccurring": true,
"cron_expression": "<string>"
}
],
"groups": [
{
"_id": "<string>",
"name": "<string>",
"roles": [
{
"_id": "<string>",
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}