getWorkspaces

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/postman/main/json-schema/postman-get-workspaces-schema.json",
  "title": "getWorkspaces",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postman-workspaces-api-openapi.yml#/components/schemas/getWorkspaces",
  "type": "object",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/getWorkspacesWorkspaceData"
      },
      "description": "A list of workspaces."
    },
    "meta": {
      "$ref": "#/$defs/GetWorkspacesMeta",
      "description": "The response's meta information for paginated results. This object only returns if you pass the `limit` query parameter."
    }
  },
  "$defs": {
    "GetWorkspacesMeta": {
      "type": "object",
      "properties": {
        "nextCursor": {
          "type": "string",
          "description": "The pagination cursor that points to the next record in the results set."
        }
      },
      "description": "The response's meta information for paginated results. This object only returns if you pass the `limit` query parameter.",
      "title": "GetWorkspacesMeta"
    },
    "GetWorkspacesWorkspaceDataType": {
      "type": "string",
      "enum": [
        "personal",
        "team",
        "private",
        "public",
        "partner"
      ],
      "description": "The type of workspace.",
      "title": "GetWorkspacesWorkspaceDataType"
    },
    "GetWorkspacesWorkspaceDataVisibility": {
      "type": "string",
      "enum": [
        "personal",
        "team",
        "private",
        "public",
        "partner"
      ],
      "description": "The workspace's visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:\n- `personal` — Only you can access the workspace.\n- `team` — All team members can access the workspace.\n- `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).\n- `public` — Everyone can access the workspace.\n- `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).\n",
      "title": "GetWorkspacesWorkspaceDataVisibility"
    },
    "getWorkspacesScimObject": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string",
          "description": "The SCIM user ID of the user who created the workspace."
        }
      },
      "description": "An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.",
      "title": "getWorkspacesScimObject"
    },
    "getWorkspacesWorkspaceData": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The workspace's ID."
        },
        "name": {
          "type": "string",
          "description": "The workspace's name."
        },
        "type": {
          "$ref": "#/$defs/GetWorkspacesWorkspaceDataType",
          "description": "The type of workspace."
        },
        "visibility": {
          "$ref": "#/$defs/GetWorkspacesWorkspaceDataVisibility",
          "description": "The workspace's visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace:\n- `personal` — Only you can access the workspace.\n- `team` — All team members can access the workspace.\n- `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).\n- `public` — Everyone can access the workspace.\n- `partner` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).\n"
        },
        "createdBy": {
          "type": "string",
          "description": "The user who created the workspace. The response only returns workspaces that you have access to."
        },
        "about": {
          "type": "string",
          "description": "A brief summary about the workspace."
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time at which the workspace was created."
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time at which the workspace was last updated."
        },
        "scim": {
          "$ref": "#/$defs/getWorkspacesScimObject"
        }
      },
      "description": "Information about the workspace.",
      "title": "getWorkspacesWorkspaceData"
    }
  }
}