Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
Get Account
curl --request GET \
  --url https://api.example.com/api/v1/accounts/{account_id}
{
  "id": "<string>",
  "account_code": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_count": 123,
  "collections_used": [
    "<string>"
  ]
}

Headers

authorization
string | null

Path Parameters

account_id
string
required

Response

Successful Response

Detailed account information.

id
string
required

Account ID (UUID)

account_code
string
required

Human-readable account code in XX#### format (e.g., AB1234)

slug
string
required

URL-friendly account identifier

name
string
required

Display name for the account

created_at
string<date-time>
required

When the account was created

updated_at
string<date-time>
required

When the account was last updated

user_count
integer
required

Number of users in this account

collections_used
string[]

Collections used by this account