Workspace Management API

Overview

• This feature is available with the Paradime Enterprise pack.

• Your API keys must have either User Management Admin or User Metadata Viewer capabilities.

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

import requests
import os

# API credentials
api_endpoint = "<YOUR_API_ENDPOINT>"
api_key = "<YOUR_API_KEY>"
api_secret = "<YOUR_API_SECRET>"

graphql_query = """
query ListWorkspaces {
    listWorkspaces {
        ok
        workspaces {
            name
            uid
        }
    }
}
  """
  
response = requests.post(api_endpoint, json={"query": graphql_query}, headers={
      "Content-Type": "application/json",
      "X-API-KEY": api_key,
      "X-API-SECRET": api_secret,
  })

print(response.json())

cURL

curl -X POST "<YOUR_API_ENDPOINT>" \
     -H "Content-Type: application/json" \
     -H "X-API-KEY: <YOUR_API_KEY>" \
     -H "X-API-SECRET: <YOUR_API_SECRET>" \
     -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"
        }
      ]
    }
  }
}