Single workspace

GET https://api.getpostman.com/workspaces/{{workspace_id}}

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.

 

Body PARAM

Key

Datatype

Required

Description

HEADERS

Key

Datatype

Required

Description

RESPONSES

status OK

{ "workspace": { "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696", "name": "Demo workspace", "type": "personal", "description": "Demos.", "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" } ], "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" } ], "mocks": [ { "id": "77aaeba0-0f94-4aa4-a60d-200f4e1ef2fb", "name": "Mock Demo", "uid": "1234-77aaeba0-0f94-4aa4-a60d-200f4e1ef2fb" }, { "id": "52a5d86f-73d4-4f86-baec-4b19983d6896", "name": "Mock Demo 2", "uid": "52a5d86f-73d4-4f86-baec-4b19983d6896" } ], "monitors": [ { "id": "efa46ba3-90da-4a84-b924-2962266c3db1", "name": "Monitor Demo", "uid": "1234-efa46ba3-90da-4a84-b924-2962266c3db1" }, { "id": "24915c49-b33e-4da1-ac20-535f82e34626", "name": "Monitor Demo 2", "uid": "1234-24915c49-b33e-4da1-ac20-535f82e34626" } ], "apis": [ { "id": "e73c756a-6777-49a2-81e4-b633af2076dd", "name": "API demo", "uid": "1234-e73c756a-6777-49a2-81e4-b633af2076dd" }, { "id": "708f2252-d83c-4fba-af22-4fbf93a4b199", "name": "API demo 2", "uid": "1234-708f2252-d83c-4fba-af22-4fbf93a4b199" } ] } }