---
title: "List groups"
method: GET
path: "/v1/groups"
tags: ["Groups"]
---

# List groups

`GET /v1/groups`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/groups`
- Auth: HTTP bearer

A group is the commission and approval axis: commission rules scope to it. Presentation and tags are separate, so one group never has to carry seven concerns.

**Scope:** `read`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: No relations on this resource
  - string
  - string[]
- `include[]` union: Extras to include: stats
  - string
  - string[]

## Response `200`

Groups

- GroupList
  - `data` Group[], required
    - `id` string, required: Prefixed id (`grp_…`)
    - `object` 'group', required
    - `program_id` string, required: Prefixed id (`prg_…`)
    - `name` string, required
    - `slug` string, required
    - `description` string, nullable, required
    - `landing_url` string, nullable, required
    - `is_private` boolean, required
    - `is_default` boolean, required
    - `stats` object
      - `partners` integer, required
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

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