> ## Documentation Index
> Fetch the complete documentation index at: https://docs.namegrid.org/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/account — Fetch Workspace & Credit Balance

> GET /v1/account — Retrieve your workspace details and current credit balance. Use this to check available credits before registering or renewing.

Use this endpoint to fetch your workspace details and current credit balance. No additional parameters are required — your API key identifies the workspace automatically. This is useful for verifying your available balance before placing orders, since registration and renewal requests will fail with a `402` if your balance is insufficient to cover the cost.

## Endpoint

**GET** `/v1/account`

No path or query parameters are required.

## Request Example

```bash theme={null}
curl https://api.namegrid.org/v1/account \
  -H "x-api-key: ng_live_xxxxxxxxxxxxxxxxxxxxxxxx"
```

## Response

**200 OK**

<ResponseField name="account" type="object">
  Details about your NameGrid workspace.

  <Expandable title="account object">
    <ResponseField name="id" type="string">
      The unique workspace identifier.
    </ResponseField>

    <ResponseField name="name" type="string">
      The display name of your workspace.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO 8601 timestamp of when the workspace was created (e.g. `2026-01-04T12:00:00.000Z`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="credits" type="object">
  Your current credit balance information.

  <Expandable title="credits object">
    <ResponseField name="balance" type="number">
      Available credit balance. 1 credit equals \$1 USD. This balance is consumed when you register or renew domains.
    </ResponseField>
  </Expandable>
</ResponseField>

```json theme={null}
{
  "account": {
    "id": "5b1e2b1a-...",
    "name": "My Workspace",
    "createdAt": "2026-01-04T12:00:00.000Z"
  },
  "credits": {
    "balance": 42.50
  }
}
```

## Checking Balance Before Actions

Registration and renewal requests fail with a `402 Payment Required` error if your credit balance is too low to cover the cost of the operation. Before placing orders in bulk, call this endpoint first to confirm you have enough credits.

<Tip>
  Check your balance before registering multiple domains in a single workflow. If your balance runs out mid-batch, earlier registrations will succeed but later ones will fail — leaving you with a partial order that may require manual cleanup.
</Tip>

<Note>
  See the [credits overview](/concepts/credits) for a full explanation of how credits work, how to top up your balance, and how costs are calculated for registration and renewal.
</Note>