---
title: "User Workspaces"
method: GET
path: "/user/workspaces"
tags: ["User Workspaces"]
---

# User Workspaces

`GET /user/workspaces`

## Request

- Base URL: `https://public-api.apptweak.com/api/public/apptweak`
- URL: `https://public-api.apptweak.com/api/public/apptweak/user/workspaces`
- Auth: API key in header `x-apptweak-key`

List every workspace accessible to your user, default workspace first. <br/><br/> Workspaces organize the applications, keywords, reports, and other resources available to an AppTweak user. `id` is the identifier to use with workspace-scoped endpoints, which take it as `workspace_ids`, and `default` says whether this is the user's default workspace. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>credits</th></tr></thead> <tbody> <tr><td><b>property object</b></td><td>List every workspace accessible to the authenticated user and retrieve IDs for workspace-scoped endpoints.</td><td>0</td></tr> </tbody> </table>

## Response `200`

Successful response.

- object
  - `result` object[]
    - `id` integer
    - `name` string
    - `default` boolean
  - `metadata` ResponseMetadata: Standard response envelope: the request as the API parsed it, the credits actually charged (`cost`), and what the call could have cost had every datapoint been available (`max_credit_cost`). Every endpoint of this API returns it unchanged.
    - `request` object
      - `path` string: The path that was called.
      - `params` object, nullable: The query as the API parsed it, with defaults applied.
      - `cost` integer: Credits actually charged for this call.
      - `max_credit_cost` integer: Credits the call could have cost if every datapoint requested had been available.
      - `status` integer: HTTP status of the response.
    - `response` object, nullable: Endpoint-specific notes; null when there are none.

## Other responses

- `401`: Unauthorized. Unknown or missing API token.
- `403`: Forbidden. Not enough credits to perform the request.
- `422`: Validation error. Returned when a parameter is invalid.

---

[API](https://skmtc.dev/apptweak/apis/apptweak-api.md) - [All operations](https://skmtc.dev/apptweak/apis/apptweak-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apptweak/apis/apptweak-api/revisions/76dfd41ade5d?raw)