Get a workspace

GET /api/workspaces/{slug}

Requires membership of the workspace, and a key granted this workspace. slug takes the workspace slug or id.

curl "https://app.kalpana.one/api/workspaces/acme" \
  --header "x-api-key: $KALPANA_API_KEY"

Response

{
  "id": "ws_123",
  "name": "Acme Marketing",
  "slug": "acme",
  "organization": { "id": "org_123", "name": "Acme", "slug": "acme" },
  "logo": null,
  "metadata": {
    "whitelistedDomains": [{ "domain": "cdn.shopify.com", "custom": false }]
  },
  "whitelistedDomains": [{ "domain": "cdn.shopify.com", "custom": false }],
  "role": "Owner",
  "permissions": ["templates:read", "batches:create"],
  "canUpdate": true,
  "isCommunityWorkspace": false
}

permissions lists the permission codes your role holds in this workspace. whitelistedDomains lists the hosts Upload from a URL accepts; custom is false for the built-in hosts. metadata holds the workspace's stored settings, including the same list. canUpdate says whether your role can change the workspace's settings. isCommunityWorkspace is true only for Kalpana's own gallery workspace.

permissions are your role's, not the key's. A key can hold fewer, as set when it was created; a call that needs one it lacks fails with 403 and This API key lacks permission: <code>.

Errors