Workspace
Workspaces can be viewed as digital workplaces. With workspaces you can collaborate with other users, prioritize work and share different types of content – all in one place. You can create multiple workspaces. One workspace can have many projects.
Note that users can have different roles and permissions in a workspace. Here you can find out more about each role.
Schema:
| Property | Type | Attributes |
|---|---|---|
| id | string | read-only |
| modified | string | read-only |
| created | string | read-only |
| name | string | min = 1, max = 100 |
| description | string | min = 1, max = 144, nullable |
| startDate | string |
|
| endDate | string |
|
| status | string enum ("none", "ontarget", "atrisk", "danger", "completed") | |
| organization | object <DocumentInfo> | read-only |
| members | array <MemberInfo> | read-only |
| requests | array <MemberInfo> | read-only |
| pendingInvites | array <MemberInfo> | read-only |
| projects | array <DocumentInfo> | read-only |
| pinLists | array <DocumentInfo> | read-only |
| taskLists | array <DocumentInfo> | read-only |
| discussionLists | array <DocumentInfo> | read-only |
| dashboardLists | array <DocumentInfo> | read-only |
Example:
{
"id": "{123456}_ws",
"modified": "2023-02-08T08:40:30.0000000",
"created": "2023-02-08T08:40:27.0000000",
"name": "Marketing",
"description": "Q1",
"startDate": "2023-02-08T08:29:02.0000000",
"endDate": "2023-02-08T08:29:02.0000000",
"status": "none",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Vyara"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tim",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedback"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
}
]
}
Create a workspace
https://my.slingshotapp.io/v1/workspaces
Required parameters: None
When you request to create a workspace, the request body will have the following content:
| Property | Type | Attributes |
|---|---|---|
| name | string | required, min = 1, max = 100 |
| description | string | min = 1, max = 144, nullable |
| startDate | string |
|
| endDate | string |
|
| status | string enum ("none", "ontarget", "atrisk", "danger", "completed") | |
| members | array <MemberInfo> |
Possible responses:
| Code | Description |
|---|---|
| 201 (Created) | You successfully created a workspace. The newly created workspace will be returned in the response body. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"name": "Marketing",
"startDate": "2023-02-08T08:29:02.597Z",
"endDate": "2023-02-08T08:29:02.597Z",
"status": "none",
"members": [
{
"id": "{123456}_u",
"name": "Vyara",
"role": "owner"
}
],
"description": "Q1"
}
{
"id": "{123456}_ws",
"modified": "2023-02-08T08:40:30.0000000",
"created": "2023-02-08T08:40:27.0000000",
"name": "Marketing",
"description": "Q1",
"startDate": "2023-02-08T08:29:02.0000000",
"endDate": "2023-02-08T08:29:02.0000000",
"status": "none",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Vyara"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tim",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedback"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
}
]
}
Get a workspace
***https://my.slingshotapp.io/v1/workspaces/{id}***
Required parameters: the id of the workspace
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You can view your workspaces. The requested Workspaces will be returned in the response body in an ItemsObject array. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Get all workspaces for a current user
https://my.slingshotapp.io/v1/workspaces
Required parameters: None
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You can view your workspaces. The requested Workspaces will be returned in the response body in an ItemsObject array. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Update a workspace
***https://my.slingshotapp.io/v1/workspaces/{id}***
Required parameters: the id of the workspace
When you request to update a workspace, the request body will have the following content:
| Property | Type | Attributes |
|---|---|---|
| name | string | min = 1, max = 100 |
| description | string | min = 1, max = 144, nullable |
| startDate | string |
|
| endDate | string |
|
| status | string enum ("none", "ontarget", "atrisk", "danger", "completed") |
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | The workspace is updated. The updated workspace will be returned in the response body. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"name": "Management",
"startDate": "2023-02-08T09:05:22.195Z",
"endDate": "2023-02-08T09:05:22.195Z",
"status": "none",
"description": "2022"
}
{
"id": "{123456}_ws",
"id": "{123456}_ws",
"modified": "2023-02-08T09:07:50.0000000",
"created": "2023-02-08T08:40:27.0000000",
"name": "Management",
"description": "2022",
"startDate": "2023-02-08T09:05:22.0000000",
"endDate": "2023-02-08T09:05:22.0000000",
"status": "none",
"organization": {
"id": "{123456}",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Vyara"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tim",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedback"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
}
]
}
Delete a workspace
https://my.slingshotapp.io/v1/workspaces/{id}
Required parameters: the id of the workspace
Possible responses:
| Code | Description |
|---|---|
| 204 (No Content) | The workspace is deleted. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Add members to a workspace
https://my.slingshotapp.io/v1/workspaces/{id}/members
Required parameters: the id of the workspace
Request body: ItemsObject <MemberInfo>
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You successfully added members to the workspace. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"items": [
{
"id": "{123456}_u",
"name": "Nik Petrov",
"role": "owner"
}
]
}
{
"id": "{123456}_ws",
"modified": "2023-02-09T14:51:20.0000000",
"created": "2023-01-23T15:15:29.0000000",
"name": "Documentation",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Vyara",
"email": "v@gmail.com"
},
{
"id": "{123456}_u",
"role": "owner",
"name": "Nik Petrov",
"email": "n@gmail.com"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tom",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Testing"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
},
{
"id": "{123456}_tg",
"name": "Threads"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
},
{
"id": "{123456}",
"name": "Feedback"
}
]
}
Update members’ roles of a workspace
https://my.slingshotapp.io/v1/workspaces/{id}/members
Required parameters: the id of the workspace
Request body: ItemsObject <MemberInfo>
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You updated the members of the workspace. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"items": [
{
"id": "{123456}_u",
"name": "Nick",
"role": "owner"
}
]
}
{
"id": "{123456}_ws",
"modified": "2023-02-13T10:37:36.0000000",
"created": "2023-01-23T15:15:29.0000000",
"name": "Customer support",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Ver",
"email": "v@gmail.com"
},
{
"id": "{123456}_u",
"role": "owner",
"name": "Nick",
"email": "n@gmail.com"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tom",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedack"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
},
{
"id": "{123456}_tg",
"name": "Q1"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
},
{
"id": "{123456}",
"name": "Emails"
},
{
"id": "{123456}",
"name": "Chats"
}
]
}
Remove members from a workspace
https://my.slingshotapp.io/v1/workspaces/{id}/members
Required parameters: the id of the workspace
Request body: ItemsObject <MemberInfo>
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You removed members from the workspace. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"items": [
{
"id": "{123456}_u",
"name": "Nick",
"role": "contributor"
}
]
}
{
"id": "{123456}_ws",
"modified": "2023-02-13T10:25:22.0000000",
"created": "2023-01-23T15:15:29.0000000",
"name": "Customer Support",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Ver",
"email": "v@gmail.com"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tom",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedback"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
},
{
"id": "{123456}_tg",
"name": "string"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
},
{
"id": "{123456}",
"name": "Email Support"
},
{
"id": "{123456}",
"name": "Chat Support"
}
]
}
Grant requests to add members to a workspace
https://my.slingshotapp.io/v1/workspaces/{id}/requests
Required parameters: the id of the workspace
Request body: ItemsObject <MemberInfo>
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You granted access to the users. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"items": [
{
"id": "{123456}_u",
"role": "owner"
}
]
}
{
"id": "{123456}_ws",
"modified": "2023-02-10T14:20:52.0000000",
"created": "2023-02-10T14:13:59.0000000",
"name": "Workspace",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Nick",
"email": "n@gmail.com"
},
{
"id": "{123456}_u",
"role": "owner",
"name": "Ver",
"email": "v@gmail.com"
},
{
"id": "{123456}_u",
"role": "owner",
"name": "Ron",
"email": "r@gmail.com"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tom",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedback"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
}
]
}
[!NOTE] Only Owners can grant requests access to add members to a workspace.
Deny requests to add members to a workspace
https://my.slingshotapp.io/v1/workspaces/{id}/requests
Required parameters: the id of the workspace
Request body: ItemsObject <MemberInfo>
Possible responses:
| Code | Description |
|---|---|
| 200 (Success) | You denied access to the users. |
| 400 (Bad Request) | The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong. |
| 403 (Forbidden) | The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication. |
| 404 (Not Found) | The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist. |
Example of a successful request body:
{
"items": [
{
"id": "{123456}_u",
"role": "owner"
}
]
}
{
"id": "{123456}_ws",
"modified": "2023-02-10T14:29:09.0000000",
"created": "2023-02-10T14:13:59.0000000",
"name": "Customer Support",
"organization": {
"id": "{123456}_org",
"name": "Doe"
},
"members": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Nick",
"email": "n@gmail.com"
},
{
"id": "{123456}_u",
"role": "owner",
"name": "Ver",
"email": "v@gmail.com"
}
],
"requests": [
{
"id": "{123456}_u",
"name": "Tom",
"email": "t@gmail.com",
"role": "owner"
}
],
"pendingInvites": [
{
"id": "{123456}_u",
"role": "owner",
"name": "Joan",
"email": "joan@gmail.com"
}
],
"projects": [
{
"id": "{123456}_proj",
"name": "Feedback"
}
],
"dashboardLists": [
{
"id": "{123456}_repo",
"name": "Q3"
}
],
"pinLists": [
{
"id": "{123456}_ws_d",
"name": "Workspace Pins"
}
],
"taskLists": [
{
"id": "{123456}_tg",
"name": "Workspace Tasks"
}
],
"discussionLists": [
{
"id": "{123456}",
"name": "Workspace Discussions"
}
]
}
[!NOTE] Only Owners can deny requests access to add members to a workspace.
