---
title: "Returns one schedule group with its active members."
method: GET
path: "/api/v1/schedule-groups/{id}"
tags: ["ScheduleGroups"]
---

# Returns one schedule group with its active members.

`GET /api/v1/schedule-groups/{id}`

## Request

- Base URL: `https://app.flexonthejob.com`
- URL: `https://app.flexonthejob.com/api/v1/schedule-groups/{id}`
- Auth: HTTP bearer

Send the previous `ETag` as `If-None-Match` to receive `304 Not Modified` when unchanged.

## Path parameters

- `id` integer, required

## Response `200`

The group, with an `ETag` header.

- ScheduleGroupDto: A scheduling group (division, crew or team) of the calling organization, as returned by `GET /api/v1/schedule-groups`. Groups form a tree via `parentGroupId`; a user may belong to several groups. Requires the `scheduling` module.
  - `id` integer: Numeric id of the group. Stable within this organization.
  - `syncId` string, uuid: Globally unique sync id (GUID). Use it as the `after` pagination cursor.
  - `name` string: Group name, e.g. `"Install Crew A"`.
  - `description` string, nullable: Optional description shown on the dispatch board.
  - `colorHex` string, nullable: Hex colour used for calendar / board rendering, e.g. `"#2e7d32"`; null when unset.
  - `parentGroupId` integer, nullable: Id of the parent group (e.g. the division a crew belongs to); null for top-level groups.
  - `parentGroupName` string, nullable: Name of the parent group; null for top-level groups.
  - `displayOrder` integer: Sort position among siblings (ascending). Pages are returned in id order, so sort by this client-side when rendering a board.
  - `members` ScheduleGroupMemberDto[]: Members of this group, leads first. Only active users are listed.
    - `userId` string: User id (string GUID) — matches `id` from `GET /api/v1/users` and job assignee ids.
    - `displayName` string: User's display name, e.g. `"Sam Carter"`.
    - `isLead` boolean: True for the crew lead / foreman of this group.
  - `createdAt` string, date-time: UTC creation timestamp.
  - `updatedAt` string, date-time, nullable: UTC timestamp of the last edit; null when never edited.

## Other responses

- `304`: Unchanged since the supplied `If-None-Match`.
- `401`: Unauthorized
- `403`: The `scheduling` module is not active for this organization.
- `404`: No such group in this organization (also for deleted groups).
- `429`: Too Many Requests

---

[API](https://skmtc.dev/flexonthejob/apis/flex-api.md) · [All operations](https://skmtc.dev/flexonthejob/apis/flex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flexonthejob/apis/flex-api/revisions/19c8f4d27acf?raw)