Skip to main content

Get Group by ID

BETA

This endpoint is in beta and may change in future releases.

GET/workspace/{workspaceId}/groups/{groupId}

Retrieves details of a specific group including its permissions.

Path Parameters
workspaceIdstringrequired
The unique identifier of the workspace.
groupIdstringrequired
The unique identifier of the group.
Error Responses
400
Group not found in the specified workspace.
401
Missing or invalid Authorization header.
403
Feature not available in current plan.
404
Not available on Community Edition.
451
License does not include this feature.
Request
curl -X GET "https://{your-domain}/api/ext/workspace/{workspaceId}/groups/{groupId}" -H "Authorization: Basic <access_token>"
Response — 200
{
"group": {
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Platform Engineers",
  "type": "custom",
  "organizationId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "appCreate": true,
  "appDelete": false,
  "folderCRUD": false,
  "orgConstantCRUD": false,
  "dataSourceCreate": false,
  "dataSourceDelete": false,
  "workflowCreate": false,
  "workflowDelete": false,
  "appPromote": false,
  "appRelease": false,
  "disabled": false,
  "createdAt": "2024-03-15T10:00:00.000Z",
  "updatedAt": "2024-05-01T12:30:00.000Z"
},
"isBuilderLevel": false
}