---
title: "Get custom page groups the user can access"
method: GET
path: "/CustomPageGroups"
tags: ["Custompagegroups"]
---

# Get custom page groups the user can access

`GET /CustomPageGroups`

**Requires permission:** *StaffMember*

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Response `200`

Success - Success

- GetCustomPageGroupsResponse
  - `groups` CustomPageGroup[]
    - `id` string, nullable
    - `title` string, nullable
    - `description` string, nullable
    - `pageType` string, nullable
    - `trackCompletion` boolean
    - `accessLevels` CustomPageGroupAccessLevel[]
      - `id` string, nullable
      - `groupId` string, nullable
      - `identifier` string, nullable
      - `level` string, nullable
      - `type` string, nullable
      - `name` string, nullable
    - `pages` CustomPage[]
      - `id` string, nullable
      - `title` string, nullable
      - `description` string, nullable
      - `owner` string, nullable
      - `modified` string, date-time
      - `published` boolean
      - `type` string, nullable
      - `customUrl` string, nullable
      - `useCard` boolean
      - `completionDescription` string, nullable
      - `isEditor` boolean
      - `accessLevels` CustomPageAccessLevel[]
        - `id` string, nullable
        - `parentId` string, nullable
        - `identifier` string, nullable
        - `type` string, nullable
        - `level` string, nullable
        - `name` string, nullable
      - `blocks` CustomPageBlock[]
        - `id` string, nullable
        - `pageId` string, nullable
        - `order` integer, nullable
        - `type` integer
        - `attributes` string, nullable
        - `parameters` string, nullable
      - `completions` CustomPageGroupCompletion[]
        - `id` integer
        - `identifier` string, nullable
        - `completion` boolean
        - `dateCompleted` string, date-time
        - `pageId` string, nullable
        - `name` string, nullable
        - `department` string, nullable
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Explain Error
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/fab57bf5558a/schema)