Workspace Management API

Overview

Prerequisites:

This feature is available with the Paradime Enterprise pack.
Your API keys must have either User Management Admin or User Metadata Viewer capabilities.

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.

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

GraphQL
cURL

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())

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 } } }"
     }'

Example response

{
  "data": {
    "listWorkspaces": {
      "ok": true,
      "workspaces": [
        {
          "name": "data-platoform",
          "uid": "r233tak125coyphm"
        },
        {
          "name": "finance",
          "uid": "vxs6x31394cqk2vd"
        },
        {
          "name": "sales",
          "uid": "fuqge1jaj1122i5k"
        }
      ]
    }
  }
}

​Overview

​List Workspaces

Overview

List Workspaces