---
title: "Get a page of component group documents"
method: GET
path: "/automation-studio/component-groups"
tags: ["Automation Studio"]
---

# Get a page of component group documents

`GET /automation-studio/component-groups`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/automation-studio/component-groups`
- Auth: none declared

Returns a page of component group documents.

## Query parameters

- `limit` integer
- `skip` integer
- `order` '-1' | '1': Sort direction, 1 for ascending and -1 for descending.
- `sort` 'name': Field to sort by
- `include` string
- `exclude` string
- `in` string
- `not-in` string
- `equals` string
- `contains` string
- `starts-with` string
- `ends-with` string

## Response `200`

Results for the given search parameters.

- AutomationStudioGetComponentGroupsResponse200
  - `items` AutomationStudioComponentGroup[]
    - `_id` string: Unique identifier of the component group
    - `name` string, required
    - `description` string
    - `gbacRead` string[], required
    - `gbacWrite` string[]
    - `members` AutomationStudioComponentGroupMembersItems[], required
      - union
        - AutomationStudioComponentGroupMembersItems0
          - `path` string[]
          - `type` 'folder'
        - AutomationStudioComponentGroupMembersItems1
          - `path` string
          - `type` 'component'
          - `sourceCollection` string
          - `ref` string
    - `version` number, double
    - `meta` AutomationStudioComponentGroupMeta
  - `total` integer: Total number of documents matching the given query parameters.
  - `start` integer: Search index of first document in the items array.
  - `end` integer: Search index of the last document in the items array.
  - `count` integer: Length of the items array.
  - `next` string, nullable: URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.
  - `previous` string, nullable: URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Automation Studio` added
  - api tag `automationStudio` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/automation-studio/component-groups/get.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)