/api/org/v1 holds the calls for your organization as a whole (see the
Organization API). Everything you do inside one
client’s workspace, such as importing, reading jobs and paths, tags and saved views, is in the
API Reference. Call those endpoints with your organization key
and name the workspace.
In the API
Add theX-Clustr-Tenant header to any /api/public/* call. Its value is the workspace’s
id or your own externalId.
- The header is required. A request without it answers
400. - The workspace must be one of yours. Any other id answers
404. - Reads (
GET) need thedata:readscope. Every other method needsjobs:write. - A suspended workspace refuses writes and still answers reads.
- Writes are recorded in
GET /api/org/v1/audit-log. Idempotency-Keyon an import means a retry cannot start the job twice. See Bulk jobs.
In MCP, with a key
The MCP server accepts the same header. Set it on the connection:In MCP, signed in
If you are an organization admin and signed in to MCP as a person, use theorg_switch_tenant tool. It makes every other tool act inside another workspace of your
organization.
tenantis the workspaceidor yourexternal_id.tenant: "home"switches back to your own workspace.- It lasts one hour, in that MCP session only. It stops working if you stop being an organization admin.
- An API key cannot use this tool. A key uses the header above.