Workspaces

Number of APIs: 5

1. Update a workspace

PUT https://api.getpostman.com/workspaces/{{workspaceId}}

Updates a workspace. You can use the following request body properties to update the workspace:

• name — A string that contains the workspace's new name.
• type — Optional. A string that contains the workspace type:
  • personal — A personal workspace.
  • team — A team workspace.
• description — Optional. A string that contains the new workspace description.

Note:

You can change a workspace's type from personal to team, but you cannot change a workspace from team to personal.

Important:

We deprecated linking collections or environments between workspaces. We do not recommend that you do this.

If you have a linked collection or environment, note the following:

• The endpoint does not create a clone of a collection or environment.
• Any changes you make to a linked collection or environment changes them in all workspaces.
• If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

---

2. Create a workspace

POST https://api.getpostman.com/workspaces

Creates a new [workspace] Include the following properties in the request body:

• name — A string that contains the workspace's name.
• type — A string that contains the workspace type:
  • personal — A personal workspace.
  • team — A team workspace.

You can include the following optional properties in the request body:

• description — A string that contains a description of the workspace.

Important:

We deprecated linking collections or environments between workspaces. We do not recommend that you do this.

If you have a linked collection or environment, note the following:

• The endpoint does not create a clone of a collection or environment.
• Any changes you make to a linked collection or environment changes them in all workspaces.
• If you delete a collection or environment linked between workspaces, the system deletes it in all the workspaces.

---

3. Get a workspace

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

Gets information about a workspace.

Note:

This endpoint's response contains the visibility field. [Visibility] determines who can access the workspace:

• only-me — Applies to the My Workspace workspace.
• personal — Only you can access the workspace.
• team — All team members can access the workspace.
• private-team — Only invited team members can access the workspace.
• public — Everyone can access the workspace.

Important

We have deprecated the name and uid responses in the following array of objects:

• collections
• environments
• mocks
• monitors
• apis

---

4. Delete a workspace

DELETE https://api.getpostman.com/workspaces/{{workspaceId}}

Deletes an existing workspace.

Important:

If you delete a workspace that has a linked collection or environment with another workspace, this will delete the collection and environment in all workspaces.

---

5. Get all workspaces

GET https://api.getpostman.com/workspaces

Gets all [workspaces] The response includes your workspaces and any workspaces that you have access to.

Note:

This endpoint's response contains the visibility field. [Visibility] determines who can access the workspace:

• only-me — Applies to the My Workspace workspace.
• personal — Only you can access the workspace.
• team — All team members can access the workspace.
• private-team — Only invited team members can access the workspace.
• public — Everyone can access the workspace.

---