Skip to main content
GET
/
workspace
/
{workspaceId}
Retrieve a workspace
curl --request GET \
  --url https://app.myhero.so/workspace/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "isDefault": false,
    "isShared": false,
    "organizationId": "<string>",
    "ownerId": "<string>",
    "collaborators": [
      {
        "userId": "<string>",
        "role": "owner"
      }
    ],
    "collaboratorTeams": [
      {
        "teamId": "<string>",
        "role": "owner"
      }
    ],
    "createdAt": 123,
    "updatedAt": 123,
    "description": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.myhero.so/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves a single workspace by workspaceId. Returns 403 if the caller is not a member, and 404 if the workspace does not exist.

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

workspaceId
string
required
Minimum string length: 1

Response

200 response

data
object
required