---
title: "GET /v1/account"
method: GET
path: "/v1/account"
tags: ["account"]
---

# GET /v1/account

`GET /v1/account`

## Request

- Base URL: `https://api.octoai.cloud`
- URL: `https://api.octoai.cloud/v1/account`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/octoml/apis/octoai-api/docs/v1/account/get.ts> (a function with typed inputs; its response is checked against the schema)

Return fields on an account

## Response `200`

A description of the account

- Account
  - `name` string, required
  - `email` string, required
  - `provider` string, required
  - `key` string, required
  - `country` string
  - `company` string
  - `status` 'ready_trial' | 'ready_billed' | 'suspended_billing' | 'suspended_tos' | 'error', required

---

[API](https://skmtc.dev/octoml/apis/octoai-api.md) - [All operations](https://skmtc.dev/octoml/apis/octoai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octoml/apis/octoai-api/revisions/ff4ad53097bc?raw)
