Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Get account

GET
/api/v1/instance/accounts/{user_id}
curl --request GET \
  --url https://example.com/api/v1/instance/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie ttx_access_token=<ttx_access_token>

One account: who it is, where it works (organizations, exercises), its sign-in state and what keeps it from being deleted.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
user_id
required
User Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InstanceAccountDetailRead
object
active_sessions
required
Active Sessions
integer
backup_codes_remaining
required
Backup Codes Remaining
integer
created_at
required
Created At
string format: date-time
dependencies
required
Dependencies
Array<object>
InstanceAccountDependencyRead
object
category
required
Category
string
count
required
Count
integer
email
required
Email
string
email_mfa_enabled
required
Email Mfa Enabled
boolean
email_reconfirmation_overdue
Email Reconfirmation Overdue
boolean
email_verification_pending
required
Email Verification Pending
boolean
email_verified_at
required
Any of:
string format: date-time
exercises
required
Exercises
Array<object>
InstanceAccountExerciseRead
object
code
required
Code
string
id
required
Id
string format: uuid
lead_evaluator
required
Lead Evaluator
boolean
lead_planner
required
Lead Planner
boolean
name
required
Name
string
organization_id
required
Organization Id
string format: uuid
organization_name
required
Organization Name
string
roles
required
Roles
Array<string>
full_name
required
Any of:
string
is_instance_admin
required
Is Instance Admin
boolean
is_self
required
Is Self
boolean
last_login_at
required
Any of:
string format: date-time
organizations
required
Organizations
Array<object>
InstanceAccountOrganizationRead
object
disabled
required
Disabled
boolean
id
required
Id
string format: uuid
name
required
Name
string
roles
required
Roles
Array<string>
sole_program_manager
required
Sole Program Manager
boolean
password_change_required
required
Password Change Required
boolean
suspended_at
required
Any of:
string format: date-time
totp_enabled
required
Totp Enabled
boolean
user_id
required
User Id
string format: uuid

Example 

{
  "email_reconfirmation_overdue": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}