Workspaces
List Workspaces
GET /v1/workspaces
Lists all available workspaces.
Responses
Code |
Message |
Action |
200 |
OK |
Returns a list of available workspaces. |
Response Example:
1
2
3
4
5
6
7 | [ { "id": 123, "name": "Workspace 1", "isPersonal": false } ] |
Request Example
1
2 | curl -X GET "https://api.skyvia.com/v1/workspaces" \ -H "Authorization: <access_token>" |
Get Workspace Details
GET /v1/workspaces/{workspaceId}
Retrieves the details of a specific workspace.
Parameters
NAME |
TYPE |
IN |
DESCRIPTION |
workspaceId |
int32 |
path |
The workspace ID to retrieve details for. |
Responses
Code |
Message |
Action |
200 |
OK |
Returns the details of the specified workspace. |
Response Example:
1
2
3
4
5 | { "id": 123, "name": "Workspace 1", "isPersonal": false } |
Request Example
1
2 | curl -X GET "https://api.skyvia.com/v1/workspaces/123" \ -H "Authorization: <access_token>" |
List Workspace Users
GET /v1/workspaces/{workspaceId}/users
Lists all users in the specified workspace. This endpoint supports filtering based on a search mask.
Parameters
NAME |
TYPE |
IN |
DESCRIPTION |
workspaceId |
int32 |
path |
The workspace ID to retrieve users for. |
searchMask |
string |
query |
Filter users by part of their name or email. |
Responses
Code |
Message |
Action |
200 |
OK |
Returns a list of users in the specified workspace. |
Response Example:
1
2
3
4
5
6
7
8
9 | [ { "id": 123, "email": "user@example.com", "fullName": "User Name", "roleId": 3, "roleName": "Administrator" } ] |
Request Example
1
2 | curl -X GET "https://api.skyvia.com/v1/workspaces/123/users" \ -H "Authorization: <access_token>" |
Add Workspace User
POST /v1/workspaces/{workspaceId}/users
Adds a user to the specified workspace.
Parameters
NAME |
TYPE |
IN |
DESCRIPTION |
workspaceId |
int32 |
path |
The workspace ID. |
Request Body
NAME |
TYPE |
DESCRIPTION |
userId |
int32 |
The ID of the user to add to the workspace. |
roleId |
int32 |
The role ID to assign to the user in the workspace. |
Request Body Example
1
2
3
4 | { "userId": 456, "roleId": 3 } |
Responses
Code |
Message |
Action |
200 |
OK |
The user was successfully added to the workspace. |
Request Example
1
2
3
4 | curl -X POST "https://api.skyvia.com/v1/workspaces/123/users" \ -H "Authorization: <access_token>" \ -H "Content-Type: application/json" \ -d '{"userId": 456, "roleId": 3}' |
Remove Workspace User
DELETE /v1/workspaces/{workspaceId}/users/{userId}
Removes a user from the specified workspace.
Parameters
NAME |
TYPE |
IN |
DESCRIPTION |
workspaceId |
int32 |
path |
The workspace ID. |
userId |
int32 |
path |
The ID of the user to be removed from the workspace. |
Responses
Code |
Message |
Action |
200 |
OK |
The user was successfully removed from the workspace. |
Request Example
1
2 | curl -X DELETE "https://api.skyvia.com/v1/workspaces/123/users/456" \ -H "Authorization: <access_token>" |
×
What is the reason for your feedback?