Postman API
  1. Workspaces
Postman API
  • API
    • Get all APIs
      GET
    • Create API
      POST
    • Delete an API
      DELETE
    • Single API
      GET
    • Update an API
      PUT
    • Get All API Versions
      GET
    • Create API Version
      POST
    • Delete an API Version
      DELETE
    • Get an API Version
      GET
    • Update an API Version
      PUT
    • Get contract test relations
      GET
    • Get documentation relations
      GET
    • Get environment relations
      GET
    • Get integration test relations
      GET
    • Get monitor relations
      GET
    • Get linked relations
      GET
    • Create relations
      POST
    • Create Schema
      POST
    • Get Schema
      GET
    • Update Schema
      PUT
    • Create collection from schema
      POST
    • Get test suite relations
      GET
    • Sync relations with schema
      PUT
  • Collections
    • All Collections
    • Create Collection
    • Create a Fork
    • Merge a Fork
    • Delete Collection
    • Single Collection
    • Update Collection
  • Environments
    • All Environments
    • Create Environment
    • Delete Environment
    • Single Environment
    • Update Environment
  • Import
    • Import exported data
    • Import external API specification
  • User
    • API Key Owner
  • Mocks
    • All Mocks
    • Create Mock
    • Delete Mock
    • Single Mock
    • Update Mock
    • Publish Mock
    • Unpublish Mock
  • Monitors
    • All Monitors
    • Create Monitor
    • Delete Monitor
    • Single Monitor
    • Update Monitor
    • Run a Monitor
  • Webhooks
    • Create Webhook
  • Workspaces
    • All workspaces
      GET
    • Create Workspace
      POST
    • Delete Workspace
      DELETE
    • Single workspace
      GET
    • Update Workspace
      PUT
  1. Workspaces

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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.getpostman.com/workspaces/'
Response 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
id
string 
optional
Example:
f8801e9e-03a4-4c7b-b31e-5db5cd771696
name
string 
optional
Example:
Demo workspace
type
string 
optional
Example:
personal
🟠404Workspace Not Found
Previous
Delete Workspace
Next
Update Workspace
Built with