List permissions

Returns permission sets defined in the workspace. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/permissions

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.

Example

Request

GET https://api.buddy.works/workspaces/buddy/permissions

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/permissions",
"html_url": "https://app.buddy.works/buddy/permissions",
"permission_sets": [
{
"url": "https://api.buddy.works/workspaces/buddy/permissions/2",
"html_url": "https://app.buddy.works/buddy/permissions/edit/2",
"id": 2,
"name": "Read-only",
"description": null,
"type": "READ_ONLY",
"repository_access_level": "READ_ONLY",
"pipeline_access_level": "READ_ONLY"
},
{
"url": "https://api.buddy.works/workspaces/buddy/permissions/3",
"html_url": "https://app.buddy.works/buddy/permissions/edit/3",
"id": 3,
"name": "Artist",
"description": null,
"type": "CUSTOM",
"repository_access_level": "READ_WRITE",
"pipeline_access_level": "DENIED"
},
{
"url": "https://api.buddy.works/workspaces/buddy/permissions/1",
"html_url": "https://app.buddy.works/buddy/permissions/edit/1",
"id": 1,
"name": "Developer",
"description": null,
"type": "DEVELOPER",
"repository_access_level": "READ_WRITE",
"pipeline_access_level": "READ_WRITE"
}
]
}