API reference/Workspace

Get workspace

Try it

Read the authenticated workspace and its current plan limits. No platform settings or credentials are returned.

GET/api/v1/workspace

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

workspace:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

No input parameters.

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{}

Input schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "workspace": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "limits": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "workspace",
    "limits"
  ],
  "additionalProperties": false
}