> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paradime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Workspace Management API

### Overview

<Info>
  **Prerequisites:**

  * This feature is available with the [**Paradime Enterprise pack**](https://www.paradime.io/enterprise).
  * Your API keys ***must*** have either User Management Admin or User Metadata Viewer capabilities.
</Info>

<Info>
  The examples below authenticate with an **account API key** — pass `Authorization: Bearer <token>` (the account key starts with `prdm_cmp_`). This is an account-wide endpoint, so the `X-Paradime-Workspace` header is **not** required. Legacy **workspace API keys** are still supported: send `X-API-KEY` and `X-API-SECRET` headers instead. See API Keys.
</Info>

The Workspace Management API enables you to view workspace metadata for your Paradime accounts.

### List Workspaces

This endpoint will return details on the current active workspaces in your Paradime Account.

**Example Request**

<Tabs>
  <Tab title="GraphQL">
    ```python theme={"system"}
    import requests
    import os

    # API credentials
    api_endpoint = "<YOUR_API_ENDPOINT>"
    api_token = "<YOUR_API_TOKEN>"          # account API key (starts with prdm_cmp_)

    graphql_query = """
    query ListWorkspaces {
        listWorkspaces {
            ok
            workspaces {
                name
                uid
            }
        }
    }
      """
      
    response = requests.post(api_endpoint, json={"query": graphql_query}, headers={
          "Content-Type": "application/json",
          "Authorization": f"Bearer {api_token}",
      })

    print(response.json())
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={"system"}
    curl -X POST "<YOUR_API_ENDPOINT>" \
         -H "Content-Type: application/json" \
         -H "Authorization: Bearer <YOUR_API_TOKEN>" \
         -d '{
           "query": "query ListWorkspaces { listWorkspaces { ok workspaces { name uid } } }"
         }'
    ```
  </Tab>
</Tabs>

<Accordion title="Example response">
  ```json theme={"system"}
  {
    "data": {
      "listWorkspaces": {
        "ok": true,
        "workspaces": [
          {
            "name": "data-platoform",
            "uid": "r233tak125coyphm"
          },
          {
            "name": "finance",
            "uid": "vxs6x31394cqk2vd"
          },
          {
            "name": "sales",
            "uid": "fuqge1jaj1122i5k"
          }
        ]
      }
    }
  }
  ```
</Accordion>


## Related topics

- [API Reference](/developers/graphql-api/api-reference/index.md)
- [GraphQL API](/developers/graphql-api/index.md)
- [Authentication](/developers/graphql-api/authentication.md)
- [Workspace Management](/developers/python-sdk/modules/workspace-management.md)
- [User Management API](/developers/graphql-api/api-reference/user-management-api.md)