---
title: "Gets schedule groups in the account."
method: GET
path: "/schedules/groups"
tags: ["Schedules"]
---

# Gets schedule groups in the account.

`GET /schedules/groups`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/schedules/groups`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/schedules/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `tree` boolean
- `id` string
- `take` integer
- `page` integer

## Response `200`

OK

- Group[]
  - `id` string, nullable: The group id
  - `name` string, nullable: The group name
  - `parent_id` string, nullable: The parent group id
  - `count` integer, nullable: The number of items in this group
  - `level` integer, nullable: The nested level of this group
  - `family` integer, nullable: The family id
  - `organization_count` integer, nullable: The organization count
  - `children` Group[], nullable: The children groups

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)