Roles
List Roles
Lists a workspace’s roles. Requires the members:read permission.
GET
/
v1
/
workspaces
/
{id}
/
roles
List Roles
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}/roles \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/workspaces/{id}/roles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/workspaces/{id}/roles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/workspaces/{id}/roles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": [
{
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"permissions": [
{}
],
"preset": {},
"position": 123,
"members_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
]
}Requires
members:read (not a separate roles:read — reading the role list is bundled with
reading members). An API key needs the workspaces:read scope.
Path
string
required
Workspace ID.
Response
APIWorkspaceRole[]
Show Toggle object
Show Toggle object
string
string
string
WorkspacePermission[]
See the permission catalog — 20 entries across apps, databases, snapshots, Blob Storage, members, roles and activities.
'admin' | 'developer' | 'operator' | 'viewer' | null
Seed role this was created from.
null for a hand-made role. Purely informational — a seed role is editable and deletable like any other.number
Display order.
number
string
string
Errors
| Status | Code | When |
|---|---|---|
| 403 | WORKSPACE_PERMISSION_DENIED | Caller lacks members:read. |
| 404 | WORKSPACE_NOT_FOUND | Workspace doesn’t exist or you’re not a member. |
Last modified on October 26, 2026
⌘I
List Roles
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}/roles \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/workspaces/{id}/roles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/workspaces/{id}/roles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/workspaces/{id}/roles"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": [
{
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"permissions": [
{}
],
"preset": {},
"position": 123,
"members_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
]
}