Groundfloor Docs

Accounts API

List, read, and update customer accounts and account-scoped audit.

Base path: /v1/accounts

See also: Customer Portal — Accounts

List accounts

GET /v1/accounts

Returns accounts the authenticated user can read.

curl -s -H "Authorization: Bearer $TOKEN" \
  "$CP_URL/v1/accounts" | jq .

Get account

GET /v1/accounts/{account_id}

Permission: read on account

Create account

POST /v1/accounts

Permission: Self-serve only when ALLOW_CUSTOMER_ACCOUNT_CREATE=true; otherwise operator-only via POST /v1/admin/accounts.

Creates account + owner membership atomically.

Request body

FieldTypeRequired
namestringYes
tenancy_archetypeenumYes
billing_contactstringNo

Update account

PATCH /v1/accounts/{account_id}

Rename or update billing contact.

Permission: administer on account

Account audit

GET /v1/accounts/{account_id}/audit?limit=50

Permission: read on account

Account quota

GET /v1/accounts/{account_id}/quota

Read-only usage vs plan-tier ceilings.

Permission: read on account

See Customer Portal — Quotas.