List workspaces
1 min
GET
/v1/workspaces
Query Parameters
- organizationIdsinteger[]
- anyRoleInWorkspaceRoleDto[]
Responses
200
- Enveloped_Seq_WorkspaceDto
- dataWorkspaceDto[]
- accessMyWorkspaceAccessDtorequired
- allowedToManageCollaboratorsbooleanrequired
- allowedToManageConfigbooleanrequired
- allowedToManageMembersbooleanrequired
- rolesWorkspaceRoleDto[]
- colorstringrequired
- createdstring<date-time>required
- externalIdstringrequired
- idstring<uuid>required
- namestringrequired
- organizationOrganizationDtorequired
- idinteger<int64>required
- namestringrequired
400
- BadRequest
- errorCodestring
- messagestringrequired
401
- Unauthorized
- messagestringrequired
403
- Forbidden
- messagestringrequired
404
- NotFound
- messagestringrequired
413
- PayloadTooLarge
- messagestringrequired
500
- InternalServerError
- messagestringrequired
curl
curl --request GET \
--url /v1/workspaces \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("/v1/workspaces", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("/v1/workspaces")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "/v1/workspaces"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
{
"data": [
{
"access": {
"allowedToManageCollaborators": false,
"allowedToManageConfig": false,
"allowedToManageMembers": false,
"roles": [
""
]
},
"color": "",
"created": "",
"externalId": "",
"id": "",
"name": "",
"organization": {
"id": "",
"name": ""
}
}
]
}400
// Bad request
{
"errorCode": "",
"message": ""
}401
// Unauthorized
{
"message": ""
}403
// Forbidden
{
"message": ""
}404
// Not found
{
"message": ""
}413
// Payload too large
{
"message": ""
}500
// Internal server error
{
"message": ""
}Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.