---
title: "List the named account groups you can schedule to"
method: GET
path: "/groups"
tags: ["Accounts"]
---

# List the named account groups you can schedule to

`GET /groups`

## Request

- Base URL: `https://www.juzpost.com/api/cli/v1`
- URL: `https://www.juzpost.com/api/cli/v1/groups`
- Auth: HTTP bearer

Returns channel groups: saved bundles of social accounts, used so you can schedule to
"all-tiktok" instead of listing account ids. The group `name` is what
`POST /schedule` accepts in its `group` field. Cursor-paginated.

## Query parameters

- `limit` integer
- `cursor` string
- `order` 'asc' | 'desc'
- `sort` 'createdAt' | 'name'
- `name` string

## Response `200`

One page of channel groups.

- GroupPage: A page of channel groups.
  - `data` Group[], required: The groups in this page.
    - `id` string, uuid, required: The group id.
    - `name` string, required: The group's name. This is the value `POST /schedule` accepts in its `group` field, matched exactly.
    - `accountIds` string[], required: Ids of the social accounts in this group, in no guaranteed order.
    - `accountCount` integer, required: How many accounts are in the group. The bulk scheduler rejects groups of more than 10 with a `422`.
    - `createdAt` string, date-time, required: When the group was created.
  - `pagination` PaginationMeta, required: Page state returned by every list operation. Keyset-based, so it stays correct while rows are being inserted, and it deliberately carries no total count.
    - `limit` integer, required: The page size actually applied, after clamping to 1-100.
    - `nextCursor` string, nullable, required: Pass this back as the `cursor` query parameter to fetch the next page. It is `null` when there is no next page.
    - `hasMore` boolean, required: True when at least one more page exists. Stop paginating when this is false rather than when the data array is short.

## Other responses

- `400`: The request body or query string failed validation. `error.message` names the first problem found.
- `401`: No bearer token was sent, or the token is unknown, revoked or malformed. Run the device login again to obtain a new token.
- `402`: The plan behind this token does not include the capability this operation needs. `error.details.requiredPlan` names the tier that does. This is never a token problem, so do not retry without changing the plan.

---

[API](https://skmtc.dev/juzpost/apis/juzpost-rest-api.md) · [All operations](https://skmtc.dev/juzpost/apis/juzpost-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/juzpost/apis/juzpost-rest-api/revisions/19296da24f95?raw)