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

# List groups

`GET /v1/groups`

## Request

- Base URL: `https://api.scrip.dev`
- URL: `https://api.scrip.dev/v1/groups`
- Auth: HTTP bearer

List all groups for your organization.

## Query parameters

- `limit` integer
- `cursor` string
- `include_archived` boolean
- `search` string
- `sort_by` 'created_at' | 'name'
- `sort_dir` 'asc' | 'desc'
- `created_after` string, date-time
- `created_before` string, date-time

## Response `200`

List of groups

- GroupListResponse: One page of groups, with the pagination details for the next page.
  - `data` GroupResponse[]: The groups on this page.
    - `created_at` string, date-time: When this group was created
    - `deleted_at` string, date-time: When the group was archived (present only if archived)
    - `id` string, uuid: Unique identifier for this group
    - `name` string: The name people see for the group.
    - `status` 'ACTIVE' | 'ARCHIVED': The group's lifecycle state.
    - `updated_at` string, date-time: When this group was last updated
  - `pagination` PaginationResponse: Cursor details for a list. `has_more` says whether another page exists, and `next_cursor` is the value to send to get it.
    - `has_more` boolean, required: Whether more results are available beyond this page
    - `next_cursor` string, nullable, required: Cursor to fetch the next page. Null on the last page

## Other responses

- `400`: Invalid query parameters (code: validation_error)
- `401`: The API key is missing or not valid. See [Authentication](https://docs.scrip.dev/authentication).
- `429`: Too many requests. Wait the number of seconds in the `Retry-After` header, then retry. See [Limits and durations](https://docs.scrip.dev/limits#rate-limits).
- `500`: Something failed on Scrip's side. Retry the request, and quote `request_id` if it keeps failing. [Errors](https://docs.scrip.dev/errors) lists every code, and the [API introduction](https://docs.scrip.dev/api-reference/introduction) describes the error format.

---

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