Single workspace

v1.0.0

Access the contents of a workspace that is accessible to you using its id (id). Includes the collections, environments, mocks and monitors of that workspace.

Requires as X-Api-Key request header or apikey URL query parameter.

Output

{
  "type": "object",
  "properties": {
    "workspace": {
      "type": "object",
      "properties": {
        "collections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "uid": {
                "type": "string"
              }
            }
          }
        },
        "description": {
          "type": "string"
        },
        "environments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "uid": {
                "type": "string"
              }
            }
          }
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    }
  }
}