Skip to main content
GET
/
workspace
/
{workspaceId}
cURL
curl --request GET \
  --url https://api.hyra.io/workspace/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "group_id": "<string>",
  "name": "<string>",
  "theme": "<string>",
  "week_starts_on": "<string>",
  "permissions": [
    "<string>"
  ],
  "onboarded": true,
  "games": [
    {
      "id": "<string>",
      "name": "<string>",
      "thumbnail": "<string>"
    }
  ],
  "shares_info": true,
  "cover_image": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workspaceId
string
required

Workspace ID

Response

200 - application/json

Default Response

​
_id
string
required
​
group_id
string
required
​
name
string
required
​
theme
string
required
​
week_starts_on
string
required
​
permissions
string[]
required
​
onboarded
boolean
required
​
games
object[]
required
​
shares_info
boolean
required
​
cover_image
string