---
title: "Get a group"
method: GET
path: "/v1/groups/{group_id}"
tags: ["Groups"]
---

# Get a group

`GET /v1/groups/{group_id}`

## Request

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

Retrieve a group by ID.

## Path parameters

- `group_id` string, uuid, required

## Response `200`

Group details

- GroupDetailResponse: A group with its tags, attributes, counters and counter settings. Read balances from the balances endpoint.
  - `attributes` object: Key-value metadata. An empty object when the group has none.
  - `counter_settings` object: Auto-reset settings for the counters that have one, keyed by counter key. An empty object when no counter resets. Set them with `reset_after` on a counter in PATCH.
  - `counters` object: Numeric accumulators, returned as strings for precision. An empty object when the group has none.
  - `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.
  - `tags` string[]: Labels for segmentation. An empty list when the group has none.
  - `updated_at` string, date-time: When this group was last updated

## Other responses

- `400`: Invalid ID format (code: validation_error)
- `401`: The API key is missing or not valid. See [Authentication](https://docs.scrip.dev/authentication).
- `404`: Resource not found (code: group_not_found)
- `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)