Workspaces

Number of APIs: 5

1. Update a workspace

PUT {{baseUrl}}/workspaces/{{workspaceId}}

Updates a workspace. Include the following properties in the request body:

• name — A string value that contains the workspace's new name.

• description — A string value that contains the new workspace description.

• type — A string value that contains the new workspace visibility [type] This property does not support the following workspace visibility changes:

  • private to public, public to private, and private to personal for Free and Basic [plans]
  • public to personal for team users only.

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 {{baseUrl}}/workspaces

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

• name — A string value that contains the workspace's name.

• type — A string value that contains the workspace type:

  • personal
  • private — Private workspaces are available on Qodex [Professional and Enterprise plans]
  • public
  • team
  • partner — [Partner Workspaces] are available on Qodex [Professional and Enterprise plans]

• description — (Optional) A string value that contains a description of the workspace.

Note:

This endpoint returns a 403 Forbidden response if the user does not have permission to create workspaces. [Admins and Super Admins] can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces.

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 {{baseUrl}}/workspaces/{{workspaceId}}

Gets information about a workspace.

Note:

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

• personal — Only you can access the workspace.
• team — All team members can access the workspace.

• private — Only invited team members can access the workspace ([Professional and Enterprise plans only]

• public — Everyone can access the workspace.

• partner — Only invited team members and [partners] can access the workspace ([Professional and Enterprise plans only]

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 {{baseUrl}}/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 {{baseUrl}}/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:

• personal — Only you can access the workspace.
• team — All team members can access the workspace.

• private — Only invited team members can access the workspace ([Professional and Enterprise plans only]

• public — Everyone can access the workspace.

• partner — Only invited team members and [partners] can access the workspace ([Professional and Enterprise plans only]

---