Skip to main content

Workspace

Retrieve workspaces

GEThttps://api.tapeapp.com/v1/workspace/org

Retrieve all workspaces that you have access to (inside the active user organization with ID 1337):

➡️    Request
curl https://api.tapeapp.com/v1/workspace/org \
-u user_key_replace_with_your_api_key:
⬅️    Response
{
"total": 2,
"workspaces": [
{
"workspace_id": 1,
"name": "Task management",
"slug": "task-management",
"type": "closed",
"description": "Manage all tasks and projects inside this workspace.",
"org_id": 1337
},
{
"workspace_id": 2,
"name": "Contact directory",
"slug": "contact-directory",
"type": "default",
"description": "Keep track of our contacts here.",
"org_id": 1337
}
]
}

Create a workspace

POSThttps://api.tapeapp.com/v1/workspace

Create a new workspace:

➡️    Request
curl -X POST https://api.tapeapp.com/v1/workspace \
-u user_key_replace_with_your_api_key:\
-H "Content-Type: application/json" \
--data '{
"name": "Task management",
"type": "closed",
"description": "Manage all tasks and projects inside this workspace."
}'

The created workspace will be returned in the response:

⬅️    Response

{
"workspace_id": 1,
"name": "Task management",
"slug": "task-management",
"type": "closed",
"description": "Manage all tasks and projects inside this workspace.",
"org_id": 1337
}
Workspace type

The type property to create workspaces needs to be one of "closed", "open", "default" and "private". This corresponds to the workspace types documented in the help center.

Update a workspace

PUThttps://api.tapeapp.com/v1/workspace/{workspaceId}

Update an existing workspace via its ID:

➡️    Request
curl -X PUT https://api.tapeapp.com/v1/workspace/1 \
-u user_key_replace_with_your_api_key:\
-H "Content-Type: application/json" \
--data '{
"name": "Task management (NEW)",
"type": "closed",
"description": "Manage all tasks and projects inside this NEW workspace."
}'

The updated workspace will be returned in the response:

⬅️    Response

{
"workspace_id": 1,
"name": "Task management (NEW)",
"slug": "task-management-new",
"type": "closed",
"description": "Manage all tasks and projects inside this NEW workspace.",
"org_id": 1337
}

Delete a workspace

DELETEhttps://api.tapeapp.com/v1/workspace/{workspaceId}

Delete a workspace via its ID:

➡️    Request
curl -X DELETE https://api.tapeapp.com/v1/workspace/1 \
-u user_key_replace_with_your_api_key:\
-H "Content-Type: application/json"

The deleted workspace will be returned in the response:

⬅️    Response

{
"workspace_id": 1,
"name": "Task management (NEW)",
"slug": "task-management-new",
"type": "closed",
"description": "Manage all tasks and projects inside this NEW workspace.",
"org_id": 1337
}

Notes

Note

Currently it is not possible to change the type of a workspace via the API. Be sure to properly create workspaces with the desired type.