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
}
}Retrieve a paginated list of groups for a project, with optional search filtering.
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
}
}Documentation Index
Fetch the complete documentation index at: https://docs.gorules.io/llms.txt
Use this file to discover all available pages before exploring further.
Personal access token is obtained through your profile
ID of the project to list groups for
Search term to filter groups by name
Current page
Number of items per page
Was this page helpful?