SurfacedBySurfacedBy Docs
DocumentationConsoleReference

Account

Read, update, and bootstrap your Console account profile.

Ask an AI:Open in ChatGPTOpen in Claude

The account resource holds your Console profile, display name, and the webhook defaults applied to new endpoints. Most customers call GET at startup to fetch their current balance summary and profile, then PATCH when they want to change mutable fields. The POST variant is only used on first sign-in via the Console UI to materialize the account row; you will not need to call it from a programmatic integration.

GET
/account
/account

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/account" \
  -H "X-API-Key: string"

Successful Response

null

PATCH
/account
/account

Request Body

application/jsonRequired

[key: string]any

Header Parameters

X-API-KeyX-Api-Key

curl -X PATCH "https://example.com/account" \
  -H "X-API-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

Successful Response

null

POST
/account
/account

Request Body

application/jsonRequired

[key: string]any

curl -X POST "https://example.com/account" \
  -H "Content-Type: application/json" \
  -d '{}'

Successful Response

null