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

List accounts

GET
/api/v1/instance/accounts
curl --request GET \
  --url 'https://example.com/api/v1/instance/accounts?limit=20&offset=0&status=all&sort_by=created_at&sort_dir=asc' \
  --cookie ttx_access_token=<ttx_access_token>

Every active account of the deployment (newest first by default), with its organizations (whatever the tenancy mode). The filters combine: status (active, suspended), organization (an id, or none), role (held there, or anywhere) and instance_admin.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 20 >= 1 <= 200
offset
Offset
integer
0
q
Any of:
string
<= 200 characters
status
Status
string
default: all
Allowed values: all active suspended
organization
Any of:
string format: uuid
role
Any of:
OrgRoleEnum
string
Allowed values: program_manager planner observer evaluator
instance_admin
Any of:
boolean
sort_by
Sort By
string
default: created_at
Allowed values: created_at name last_login
sort_dir
Sort Dir
string
default: desc
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InstanceAccountListResponse
object
items
required
Items
Array<object>
InstanceAccountRead
object
created_at
required
Created At
string format: date-time
email
required
Email
string
full_name
required
Any of:
string
is_instance_admin
required
Is Instance Admin
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
suspended_at
required
Any of:
string format: date-time
user_id
required
User Id
string format: uuid
limit
required
Limit
integer
offset
required
Offset
integer
total
required
Total
integer

Example generated

{
  "items": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "email": "example",
      "full_name": "example",
      "is_instance_admin": true,
      "last_login_at": "2026-04-15T12:00:00Z",
      "organizations": [
        {
          "disabled": true,
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "name": "example",
          "roles": [
            "example"
          ],
          "sole_program_manager": true
        }
      ],
      "suspended_at": "2026-04-15T12:00:00Z",
      "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

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"
    }
  ]
}