---
title: "Get User State (v2)"
method: GET
path: "/v2/users/{id}/state"
tags: ["Users State"]
---

# Get User State (v2)

`GET /v2/users/{id}/state`

Returns the authenticated user's state (v2). The path ID must be `0`; any non-zero value is rejected. V2 payload includes `domains`, optional `fines`, and `business_unit_users`.

## Path parameters

- `id` integer, required

## Headers

- `X-New-Login` boolean, required

## Response `200`

Successful retrieval of user state (v2)

- UserStateResponseV2
  - `cache_name` string, required — The cache key that the user state has been stored under.
  - `user_id` integer, required — users.user_id
  - `username` string, required — users.username
  - `name` string — Obtained from access token until persisted in DB (applies when id = 0).
  - `status` 'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'DEACTIVATED', required — Derived user status.
  - `version` integer, required — users.version
  - `domains` Domains, required
    - `fines` Domain, required — Domain object
      - `business_unit_users` BusinessUnitUser[], required — unresolved $ref

## Other responses

- `400` — Invalid request (for example, non-zero user id)
- `404` — User not found

---

[API](https://skmtc.net/hm-courts-and-tribunals-service/apis/opal-user-service-user-state.md) · [All operations](https://skmtc.net/hm-courts-and-tribunals-service/apis/opal-user-service-user-state/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hm-courts-and-tribunals-service/opal-user-service-user-state/revisions/56ba28b4bd4b/schema)