Dynamo Developer DocsDynamo Developer Docs
External APIWorkspaces

List workspaces

List the org's workspaces to discover `workspaceId`s — the entrypoint for the workspace-scoped VIP routes, which exist only in VIP workspaces.

get/workspaces

Beta

The External API is in beta. Endpoints, parameters, and response shapes may change — including breaking changes — in future releases. Pin to documented behavior before relying on it in production.

Authorization

x-api-key x-date x-signature x-api-version
x-api-key<token>

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp as an IMF-fixdate string (GMT, US locale) "EEE, dd MMM yyyy HH:mm:ss z", e.g. "Sun, 06 Dec 2020 12:59:11 GMT". 30-second TTL.

In: header

x-signature<token>

HMAC-SHA256 of the x-date string keyed by your secret, lowercase hex.

In: header

x-api-version<token>

API version you're coding against — currently 1. Required; a missing or unsupported value returns 400 with Missing or unsupported x-api-version header. Supported versions: 1.

In: header

Response Body

application/json

application/json

application/json

Try it

read-only

Kept in this tab only and signed in your browser — your secret never leaves your device.

Enter your key and secret to send.

curl -X GET "https://example.com/workspaces"
[  {    "id": "string",    "name": "string",    "type": "VIP",    "vipIndicator": "string",    "vipIndicatorInProcess": true  }]
{  "message": "string"}
{  "message": "string"}