Accounts

Retrieve account details

Return detailed information for a specific account.

The Retrieve Account Details endpoint returns information about the authenticated account (the account associated with the provided access token). This is often used for profile screens, account dashboards, or verifying ownership.

Endpoint

GET /v1/account

Headers

Key	Value	Required
Authorization	Bearer <access_token>	Yes

Response

Successful Response (200 OK)

{
  "id": "acct_001",
  "email": "owner@example.com",
  "name": "Acme Inc.",
  "type": "business",
  "status": "active",
  "created_at": "2024-05-12T09:30:00Z",
  "updated_at": "2025-09-18T19:55:00Z",
  "settings": {
    "currency": "USD",
    "timezone": "America/New_York",
    "language": "en"
  }
}

Field	Type	Description
id	string	Unique identifier of the account.
email	string	The primary email address linked to the account.
name	string	Account name (business or individual).
type	string	individual or business.
status	string	Current account status (active, suspended, pending).
created_at	string	ISO 8601 timestamp when the account was created.
updated_at	string	ISO 8601 timestamp when the account was last updated.
settings	object	Account preferences (currency, timezone, language).

Error Response (401 / 403)

{
  "error": "unauthorized",
  "message": "Access token is invalid or expired."
}

Error Code	Meaning
unauthorized	Access token missing, expired, or invalid.
forbidden	The token does not have access to account details.

Example Usage

cURL

curl -X GET "https://api.example.com/v1/account" \
  -H "Authorization: Bearer your_access_token"

JavaScript (Fetch)

const response = await fetch("https://api.example.com/v1/account", {
  method: "GET",
  headers: {
    "Authorization": "Bearer your_access_token"
  }
});

const data = await response.json();
console.log(data.name);

This endpoint always returns details of the currently authenticated account. To retrieve another account, you must use admin or elevated privileges with the relevant account ID (if supported).

List all users

Create an account

Need help? Contact Support

Join our Discord Community

Questions? Contact Sales

On this page

Title