Get Workspace Overview
Fetch the current workspace basics, member scale, product switches, and a self-check of this credential's boundary.
Get Workspace Overview
When to use
Use this endpoint before doing anything else, to learn what kind of workspace you are in and how far this credential reaches. It returns the workspace basics and the credential's boundary in one call, which makes it a good first step for an automation.
Compared with Get Current Identity: that endpoint answers "who am I" and returns the integration identity itself; this one answers "what environment am I in and how much can I touch".
Endpoint
| Item | Value |
|---|---|
| Method | GET |
| Path | /v2/workspace |
| Request body | None |
| Returns | workspace |
| Scope | No additional scope |
Permissions
A valid token is enough, same as Get Current Identity. Page-scoped credentials may call it too: they also need to know their own boundary.
Request parameters
This endpoint takes no path parameters, query parameters or request body.
Response
{
"object": "workspace",
"id": "dddddddd-dddd-4ddd-8ddd-dddddddddddd",
"name": "Demo workspace",
"icon": { "type": "emoji", "emoji": "🚀" },
"plan_type": "team",
"member_count": 12,
"guest_count": 2,
"root_page_count": 8,
"settings": {
"backlink_enabled": true,
"ai_enabled": true,
"export_disabled": false,
"public_share_disabled": false
},
"credential": {
"resource_scope": "workspace",
"delegating_user_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
"is_guest": false,
"scopes": ["pages.read", "blocks.read", "databases.read", "search.read"]
}
}
Field notes
Counts
| Field | Meaning |
|---|---|
member_count |
Workspace members, excluding external collaborators. |
guest_count |
External collaborators holding an active role. |
root_page_count |
Top-level nodes this credential can read, not the workspace's raw total. |
Product switches
settings projects only the switches that affect automation: whether backlinks are on, whether workspace AI is on, whether export is disabled, and whether public sharing is disabled.
Credential self-check
credential describes this token's boundary in the workspace:
| Field | Meaning |
|---|---|
resource_scope |
workspace can reach the whole workspace; pages only the explicitly granted pages and their subtrees. |
delegating_user_id |
The user this integration acts for. Per-user views such as the sidebar sections resolve against it; null means there is no such view. |
is_guest |
Whether that user is an external collaborator of this workspace. External collaborators have no team section. |
scopes |
Effective scopes of this credential, the intersection of its capability ceiling and the granted OAuth scopes. |
resource_scope carries the same value as the X-Resource-Scope response header from Get Current Identity. It is repeated here so a single call can answer the whole boundary question.
Behavior
- Counts and the readable top-level total are computed per request and change as permissions change.
root_page_countis filtered by read access, so a credential granted only part of the workspace sees a smaller number than the workspace's real size.- This endpoint does not return capacity, billing, custom domain or public homepage information.
Errors
401 unauthorized: the token is invalid or expired.