Single workspace

GET

/workspaces/{workspace_id}

Workspaces

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 API Key as X-Api-Key request header or apikey URL query parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.getpostman.com/workspaces/'

Response Example

200 - Valid Response

{
  "workspace": {
    "collections": [
      {
        "id": "7c31b469-bd43-4411-9283-6d397855ee0e",
        "name": "Mock demo - collection",
        "uid": "1234-7c31b469-bd43-4411-9283-6d397855ee0e"
      },
      {
        "id": "356fe068-a0f8-4f31-b34d-d12149eac681",
        "name": "Mock demo - response code",
        "uid": "1234-356fe068-a0f8-4f31-b34d-d12149eac681"
      }
    ],
    "description": "Demos.",
    "environments": [
      {
        "id": "423fd955-a9c8-47cd-9ab0-09a6a575c4be",
        "name": "Mock demo - CNX",
        "uid": "1234-423fd955-a9c8-47cd-9ab0-09a6a575c4be"
      },
      {
        "id": "24c45c84-5147-4c15-bb9a-c3186b81d3cc",
        "name": "Mock Demo - response code",
        "uid": "1234-24c45c84-5147-4c15-bb9a-c3186b81d3cc"
      }
    ],
    "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696",
    "name": "Demo workspace",
    "type": "personal"
  }
}

Request

Path Params

workspace_id

string

required

Responses

🟢200Valid Response

application/json

Body

workspace

object

optional

collections

array [object {3}]

optional

description

string

optional

Example:

Demos.

environments

array [object {3}]

optional

string

optional

Example:

f8801e9e-03a4-4c7b-b31e-5db5cd771696

name

string

optional

Example:

Demo workspace

type

string

optional

Example:

personal

🟠404Workspace Not Found

Modified at 2023-08-15 05:41:04

Delete Workspace

Update Workspace