core toolset
get_workspace_overview
Get the workspace overview. Describes the workspace: name, portal and admin URLs, the boards you can see with their categories, the post statuses in order, portal features, and limits to plan around (page and bulk sizes, attachment size, idempotency key lifetime). Members and service accounts also get the internal tags and team size by role. Call it after whoami at the start of a session; use the names and IDs it returns in other tools. No side effects.
- Toolset
- core
- Who can call it
- OwnersManagersContributorsCustomersAPI keysVisitors
- REST
GET /api/v1/w/{workspace}/overview- Behavior
- read-onlyidempotent
Input
No input.
Output
| Field | Type | Description |
|---|---|---|
workspacerequired | object | |
portalrequired | object | |
brandingrequired | object | The portal's look (M5.4). |
boardsrequired | array of object | Boards you can see, in portal order. list_boards has full details. |
statusesrequired | array of object | Post statuses in order; is_default marks the one new posts get. |
tagsrequired | array of object or null | Internal tags, by name; null for end users, who never see tags. |
custom_fieldsrequired | array of object or null | Custom fields on posts, users and companies; null for end users. |
segmentsrequired | array of object or null | Saved segments (for voter_segment filters); null for end users. |
roadmapsrequired | array of object or null | Internal roadmaps (for get_roadmap and on_roadmap filters); null for end users. |
team_membersrequired | array of object or null | Team members to assign as owners (assign_post_owner); null for end users. |
teamrequired | object or null | Team size by role; null for end users. |
limitsrequired | object |
Calling it
// MCP: tools/call
{ "name": "get_workspace_overview", "arguments": {} }
// Typed client
await carechannel.get_workspace_overview({});