Discover the workspaces accessible to the authenticated user and retrieve IDs for workspace-scoped endpoints.
Workspaces organize the applications, keywords, reports, and other resources available to an AppTweak user.
Use the User workspaces endpoint to list every workspace accessible to the authenticated user. The returned id values can then be supplied to workspace-scoped endpoints such as Followed applications and Followed keywords.
The default workspace is returned first. Remaining workspaces are ordered by ID.
Response fields
| Field | Type | Description |
|---|---|---|
id | integer | Identifier to use with workspace-scoped endpoints. |
name | string | Workspace name. |
default | boolean | Whether this is the user's default workspace. |
Example workspace
{
"id": 42,
"name": "Default workspace",
"default": true
}Price
The User workspaces endpoint costs 0 credits per call.