Groups

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

Lists all groups assigned to the specified project. The authorized user must have admin rights in the project to get the information about permissions in that project.

Request

REQUIRED SCOPES
WORKSPACE
URL PARAMETERS
domainrequired string
The workspace domain.
project_namerequired string
The name of the project.
GET PARAMETERS
pageinteger
The number of the successive pages (results are split into pages of per_page elements each).
per_pageinteger
Specifies the number of returned elements on a page.
sort_bystring
Specifies the ordering. Can be one of email or name.
sort_directionstring
Specifies the direction of the ordering. Can be one of ASC or DESC.

Last modified on Sep 23, 2024

Example:

CURL
curl -X GET "https://api.buddy.works/workspaces/:domain/projects/:project_name/groups" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "Content-Type: application/json" \
EXAMPLE RESPONSE
{ "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" } } ] }
STATUS
200 OK
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999