v4

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-02133.2 KB
Users State

Get User State (v2)

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.

get/v2/users/{id}/state

Path parameters

idinteger required

User identifier. Must be 0 for the authenticated user.

Headers

X-New-Loginboolean required

Indicates whether this request is immediately following a login.

  • true: request immediately after login
  • false: standard refresh of user state.

Response

Successful retrieval of user state (v2)

cache_namestring required

The cache key that the user state has been stored under.

user_idinteger required

users.user_id

usernamestring required

users.username

namestring

Obtained from access token until persisted in DB (applies when id = 0).

status'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'DEACTIVATED' required

Derived user status.

versioninteger required

users.version