---
title: "Retrieve an Account"
method: GET
path: "/v1/accounts/{accountId}"
tags: ["Accounts and money"]
---

# Retrieve an Account

`GET /v1/accounts/{accountId}`

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/accounts/{accountId}`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Retrieve a single Account by its accountId. A Hyperscale Account: a first-party, ledger-backed balance held for a platform, Product, entity, customer, escrow, settlement, or suspense purpose. It is never an external bank account.

## Path parameters

- `accountId` string, required

## Query parameters

- `productId` string: Hyperscale product ID

## Headers

- `X-Hyperscale-Environment` 'sandbox' | 'live'

## Response `200`

Success

- AccountRetrieveOutput
  - `accountId` string, required: Hyperscale account ID
  - `tenantId` string, required: Organization tenant ID
  - `id` string, required
  - `role` 'tenant_billing' | 'tenant_credit' | 'tenant_settlement' | 'tenant_master_mirror' | 'customer_balance' | 'customer_investment' | 'instrument_account' | 'product_escrow' | 'product_pool' | 'product_credit' | 'product_revenue' | 'platform_estate_mirror' | 'platform_revenue' | 'platform_suspense'
  - `currency` string
  - `status` 'pending' | 'open' | 'frozen' | 'closed'
  - `ownerParticipantId` string
  - `book` string
  - `external` boolean
  - `contra` boolean
  - `createdOperationId` string
  - `ownerKind` 'platform' | 'tenant' | 'customer' | 'product' | 'external'
  - `ownerCustomerId` string: Tenant-local customer ID
  - `productName` string
  - `accountLabel` string
  - `balance` object
    - `settled` string, required: Signed minor-unit integer amount serialized as a string (at most 18 digits)
    - `pending` string, required: Signed minor-unit integer amount serialized as a string (at most 18 digits)
    - `available` string, required: Signed minor-unit integer amount serialized as a string (at most 18 digits)
    - `currency` 'SAR', required
  - `ownerName` string
  - `holderLabel` string
  - `record` object
    - `productId` string, required: Hyperscale product ID
    - `kind` string, required
    - `objectId` string, required
    - `title` string, required
  - `updatedAt` string, date-time, required
  - `createdAt` string, date-time

## Other responses

- `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance.

---

[API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)