List groups

The authorized user must have admin rights in the project to get the information about permissions in that project.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/projects/:project_name/groups

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
project_name
Required
StringThe name of the project.

GET Parameters

NameTypeDescription
pageIntegerThe number of the successive pages (results are split into pages of per_page elements each).
per_pageIntegerSpecifies the number of returned elements on a page.
sort_byStringSpecifies the ordering. Can be one of email or name.
sort_directionStringSpecifies the direction of the ordering. Can be one of ASC or DESC.

Example

Request

GET https://api.buddy.works/workspaces/buddy/projects/company-website/groups

Sample Response

HTTP

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

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/2/groups",
  "html_url": "https://app.buddy.works/buddy/company-website/team",
  "groups": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/2/group/2",
      "html_url": "https://app.buddy.works/buddy/company-website/team",
      "id": 2,
      "name": "Developers",
      "permission_set": {
        "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",
        "sandbox_access_level": "READ_ONLY"
      }
    }
  ]
}