---
title: "Inspect a unit of work and what remains to undo"
method: GET
path: "/v1/groups/{groupKey}"
tags: ["Groups"]
---

# Inspect a unit of work and what remains to undo

`GET /v1/groups/{groupKey}`

## Request

- Base URL: `https://ratchetgate.com`
- URL: `https://ratchetgate.com/v1/groups/{groupKey}`
- Auth: HTTP bearer

## Path parameters

- `groupKey` string, required

## Response `200`

Default Response

- object
  - `group_id` string
  - `group_key` string
  - `state` 'open' | 'committed' | 'unwinding' | 'unwound' | 'unwind_failed'
  - `reason` string, nullable
  - `steps` object[]: Compensations to perform, in the order given — reverse of completion order.
  - `irreversible` object[]: Effects that succeeded but declared no compensation. These cannot be rolled back automatically.
  - `unresolved` object[]: Effects whose real-world outcome is unknown. Resolve these BEFORE rolling back around them.
  - `next_step` string

## Other responses

- `400`: Invalid request.
- `401`: Missing or invalid API key.
- `402`: Insufficient prepaid credit.
- `403`: Scope, policy, or budget refusal.
- `404`: Not found.
- `409`: Conflicting state or idempotency-key reuse.
- `413`: Payload too large.
- `429`: Rate limit exceeded.

---

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