30 Days of Postman exercises API Documentation

Workspaces

Number of APIs: 5

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

The /workspaces endpoint returns a list of all workspaces that is accessible by you. The list includes your own workspaces and the workspaces that you have access to.

The response contains an array of collection information containing the name, id, and type of each workspace.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

2. 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.

3. Create Workspace

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

This endpoint allows you to create a workspace and populate it with entities like collections, environments, mocks and monitors using their uid.

On successful creation of the workspace, the response returns the workspcae name and id.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

4. Update Workspace

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

This endpoint allows you to update a workspace and update it's association to entities like collections, environments, mocks and monitors using their uid.

On successful updation of the workspace, the response returns the workspcae name and id.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Note : The endpoint expects you to send the desired state of the workspace in terms of the associated entities so be careful when trying to update these entities.

For eg. if your workspace has collections A and B, and in the update call, you send C's uid in the collections array, then A and B would be removed from the workspace and C would be added.

5. Delete Workspace

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

This endpoint allows you to delete an existing workspace.

On successful deletion of the workspace, the response returns the id.

Requires API Key as X-Api-Key request header or apikey URL query parameter.