Groups summary

What it does

Returns all groups in a project with breadcrumb id and display-name paths. Useful for resolving group paths (for example in the CLI) without walking the hierarchy level by level.

Request

GET /api/v1/projects/{id}/groups/summary

Auth	Required
Query parameters	None
Body	None

Path parameters

Name	Type	Description
id	string	Project id

Headers

Authorization: Bearer <your-api-key>

Example

curl -sS https://collingo.app/api/v1/projects/clproj0123456789abcdefgh/groups/summary \
  -H "Authorization: Bearer <your-api-key>"

Response

200 OK

Array of group summaries (not paginated):

[
  {
    "id": "clgroup0123456789abcdefg",
    "displayName": "Pages",
    "technicalName": "pages",
    "breadcrumbs": [],
    "breadcrumbNames": []
  },
  {
    "id": "clgroup9876543210abcdefg",
    "displayName": "Home",
    "technicalName": "home",
    "breadcrumbs": ["clgroup0123456789abcdefg"],
    "breadcrumbNames": ["Pages"]
  }
]

breadcrumbs / breadcrumbNames list ancestors from root → parent and do not include the group itself.

Errors

Status	When
401	Missing or invalid API key (ERR_UNAUTHORIZED)
403	Insufficient role (ERR_FORBIDDEN)
404	Project not found
500	Database or internal error