Skip to main content
GET
/
api
/
projects
/
{projectId}
/
groups
List groups
curl --request GET \
  --url https://api.example.com/api/projects/{projectId}/groups \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "permissions": [
        "owner"
      ],
      "description": "<string>",
      "filePermissions": [
        {
          "effect": "allow",
          "actions": [],
          "id": "<string>",
          "patterns": "<string>"
        }
      ],
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>"
      }
    }
  ],
  "paginate": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

ID of the project to list groups for

Query Parameters

Search term to filter groups by name

page
number
default:1

Current page

perPage
number
default:10

Number of items per page

Response

200 - application/json

Paginated list of groups

Paginated list of groups

results
object[]
required

List of groups

paginate
object
required

Pagination metadata