Skip to main content

​
Summary

Return the canonical workspace object for the specified workspace ID. Use this endpoint to display workspace branding or seed dashboards.

​
Request

GET https://api.planetaryapp.us/v1/workspace/{workspace_id}/info

​
Headers

  • Authorization: Bearer orbit_<api_key>

​
Response example

{
  "success": true,
  "workspace": {
    "groupId": 14144149,
    "name": "My Workspace",
    "description": "Workspace description",
    "logo": "https://example.com/logo.png",
    "memberCount": 42,
    "roles": [
      {
        "id": "clz1234abcd",
        "name": "Owner",
        "permissions": ["MANAGE_MEMBERS", "MANAGE_ROLES", "MANAGE_SESSIONS"]
      }
    ]
  }
}
Cached results update every 30 seconds—expect eventual consistency for member counts and role changes.

​
Code samples

GET https://api.planetaryapp.us/v1/workspace/14144149/info
Authorization: Bearer orbit_your_api_key