---
title: "Lists schedule groups with their active members, one page at a time."
method: GET
path: "/api/v1/schedule-groups"
tags: ["ScheduleGroups"]
---

# Lists schedule groups with their active members, one page at a time.

`GET /api/v1/schedule-groups`

## Request

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

Groups are flat with a `parentGroupId`; nest them client-side. Example:
`GET /api/v1/schedule-groups?parentGroupId=3` returns the crews of division 3.
Also available as CSV (`Accept: text/csv` or `?format=csv`); paging cursor in `X-Next-Cursor`.

## Query parameters

- `after` string
- `limit` integer
- `updatedSince` string, date-time
- `parentGroupId` integer
- `format` 'csv'

## Response `200`

A page of groups.

- PagedResponseOfScheduleGroupDto: One page of a cursor-paginated /api/v1 collection (API_AND_MCP.md: `?after=<syncId>&limit=`).
  - `items` ScheduleGroupDto[]: Items of this page in ascending creation order.
    - `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.
  - `nextCursor` string, nullable: SyncId of the last item; pass it back as `?after=` to fetch the next page. `null` when this is the last page.

## Other responses

- `400`: Malformed `after` cursor.
- `401`: Unauthorized
- `403`: The `scheduling` module is not active for this organization.
- `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)