Permission sets in a workspace

View as Markdown
  • GET
  • /workspaces
  • /:workspace
  • /permissions

Get details of custom permission sets in a workspace

Request

REQUIRED SCOPES
PERMISSION_READ
URL PARAMETERS
workspacerequiredstring
Workspace domain

Example: "my-company"

Response

RESPONSE BODY
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
permission_setsPermissionSetView[]

Last modified on Apr 22, 2026

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/permissions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"
EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/my-workspace/permissions",
  "html_url": "https://app.buddy.works/my-workspace/-/permissions",
  "permission_sets": [
    {
      "url": "https://api.buddy.works/workspaces/my-workspace/permissions/1",
      "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/1",
      "id": 1,
      "name": "Developer",
      "type": "DEVELOPER",
      "repository_access_level": "READ_WRITE",
      "pipeline_access_level": "READ_WRITE",
      "sandbox_access_level": "READ_WRITE",
      "project_team_access_level": "READ_ONLY",
      "environment_access_level": "MANAGE",
      "artifact_access_level": "MANAGE"
    },
    {
      "url": "https://api.buddy.works/workspaces/my-workspace/permissions/2",
      "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/2",
      "id": 2,
      "name": "Viewer",
      "type": "READ_ONLY",
      "repository_access_level": "READ_ONLY",
      "pipeline_access_level": "READ_ONLY",
      "sandbox_access_level": "READ_ONLY",
      "project_team_access_level": "READ_ONLY",
      "environment_access_level": "USE_ONLY",
      "artifact_access_level": "READ_ONLY"
    },
    {
      "url": "https://api.buddy.works/workspaces/my-workspace/permissions/3",
      "html_url": "https://app.buddy.works/my-workspace/-/permissions/edit/3",
      "id": 3,
      "name": "Project Manager",
      "type": "PROJECT_MANAGER",
      "repository_access_level": "MANAGE",
      "pipeline_access_level": "READ_WRITE",
      "sandbox_access_level": "READ_WRITE",
      "project_team_access_level": "MANAGE",
      "environment_access_level": "MANAGE",
      "artifact_access_level": "MANAGE"
    }
  ]
}
STATUS
200 Permission sets retrieved successfully