list_accounts

Generated automatically from the published contract sources.

Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.

A script calls this action over HTTPS at POST https://turnzero.ai/api/v1/actions/list_accounts, with a bearer credential and the action's payload as the JSON body. It also accepts GET.

Contract description

List every account on the platform with its sign-in address and its standing. Super-admin (platform operator) only.

Access and action metadata

{
  "name": "list_accounts",
  "resource": "account",
  "tier": "observe",
  "clients": [
    "bearer",
    "browser_session"
  ],
  "grant": "super_admin",
  "summary": "Every account with its standing — the operator's enumeration (the active-account count is this action's aggregate). Each row's provider-verified sign-in address is answered where the operator's own pages and processes read it, and withheld here, where every row answers none and the answer states `addresses: withheld`.",
  "annotations": {
    "readOnlyHint": true,
    "destructiveHint": false,
    "openWorldHint": false,
    "idempotentHint": true
  }
}

MCP catalog entry

{
  "name": "list_accounts",
  "tier": "observe",
  "scenario": "API-L0-12",
  "summary": "List every account on the platform with its sign-in address and its standing. Super-admin (platform operator) only.",
  "owners": [
    "API-L0-12"
  ]
}

request

JSON pointer Description and constraints
"" (root) Type: object
Additional properties: false

response

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["contract_version","accounts","count","active_count"]
/properties/contract_version Required value: 1
/properties/reference The short reference the platform recorded this call under, ten lowercase hexadecimal characters, the value the call’s record row carries; quote it when reporting the call.

Type: string
Pattern: ^[0-9a-f]{10}$
/properties/accounts Type: array
/properties/accounts/items Type: object
Required fields: ["id","created_at","standing","synthetic","unbilled","address"]
/properties/accounts/items/properties/id Type: string
/properties/accounts/items/properties/created_at Type: string
/properties/accounts/items/properties/standing Allowed values: ["active","suspended"]
/properties/accounts/items/properties/synthetic true on a synthetic account — a test fixture seed_synthetic_accounts created, which no sign-in creates and no billing or product analytics counts (ACB-L0-79) — and false on every account a sign-in created.

Type: boolean
/properties/accounts/items/properties/unbilled true on an account a super-admin has marked unbilled, the company's own or a complimentary one — free of the per-account application limits and never charged (ACB-L0-84) — and false on every other account.

Type: boolean
/properties/accounts/items/properties/address the account's provider-verified sign-in address, the one read_account answers as the account's own address — the platform's record about the account and never its tenant's data (API-L0-12) — or null where the account holds no identity with a verified address. It is null on every row of the assistant surface, which withholds the addresses and says so in `addresses`

Type: ["string","null"]
/properties/count Type: integer
/properties/active_count Type: integer
/properties/detail Type: string
/properties/addresses stands, reading `withheld`, on the surface that withholds the rows' sign-in addresses - the assistant surface, whose caller carries what it reads to its own provider (API-L0-12) - and is absent where the addresses are answered

Required value: withheld

Complete payload contract

{
  "request": {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "accounts",
      "count",
      "active_count"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "reference": {
        "type": "string",
        "pattern": "^[0-9a-f]{10}$",
        "description": "The short reference the platform recorded this call under, ten lowercase hexadecimal characters, the value the call’s record row carries; quote it when reporting the call."
      },
      "accounts": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "id",
            "created_at",
            "standing",
            "synthetic",
            "unbilled",
            "address"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "created_at": {
              "type": "string"
            },
            "standing": {
              "enum": [
                "active",
                "suspended"
              ]
            },
            "synthetic": {
              "type": "boolean",
              "description": "true on a synthetic account — a test fixture seed_synthetic_accounts created, which no sign-in creates and no billing or product analytics counts (ACB-L0-79) — and false on every account a sign-in created."
            },
            "unbilled": {
              "type": "boolean",
              "description": "true on an account a super-admin has marked unbilled, the company's own or a complimentary one — free of the per-account application limits and never charged (ACB-L0-84) — and false on every other account."
            },
            "address": {
              "type": [
                "string",
                "null"
              ],
              "description": "the account's provider-verified sign-in address, the one read_account answers as the account's own address — the platform's record about the account and never its tenant's data (API-L0-12) — or null where the account holds no identity with a verified address. It is null on every row of the assistant surface, which withholds the addresses and says so in `addresses`"
            }
          }
        }
      },
      "count": {
        "type": "integer"
      },
      "active_count": {
        "type": "integer"
      },
      "detail": {
        "type": "string"
      },
      "addresses": {
        "const": "withheld",
        "description": "stands, reading `withheld`, on the surface that withholds the rows' sign-in addresses - the assistant surface, whose caller carries what it reads to its own provider (API-L0-12) - and is absent where the addresses are answered"
      }
    }
  }
}

Shared contracts