Skip to main content
GET
/
workspace
/
{workspaceId}
/
dashboard-info
Retrieve workspace dashboard info
curl --request GET \
  --url https://app.myhero.so/workspace/{workspaceId}/dashboard-info \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "workspace": {
      "_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>"
    },
    "members": [
      {
        "_id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "fbUid": "<string>",
        "avatarId": "<string>"
      }
    ],
    "teams": [
      {
        "_id": "<string>",
        "name": "<string>",
        "role": "owner"
      }
    ],
    "pendingInvites": [
      "<unknown>"
    ]
  }
}

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.

Returns aggregated information for the workspace dashboard, including the workspace record, member profiles, and teams. Owners and admins also receive the list of pending invitations.

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

workspaceId
string
required
Minimum string length: 1

Response

200 response

data
object
required