Skip to navigation
APIChart of Accounts

Retrieve the chart of accounts

Retrieves the workspace’s chart of accounts: the chart document it saved, that document’s version, the rules_version of its caption rules and its active_export_system. Until the workspace saves a chart, chart is null, version is 0 and the platform’s accounts apply; the Statement mapping page lists them with their ids. Requires a plan that includes spreads; other plans get a 403.

Requires the chart_of_accounts:read, chart_of_accounts:write or extractions:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-07-19. Omit to get the latest. See Versioning.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-07-19.

RateLimit-Limitinteger

Request budget of the endpoint's rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
chartany or null
versioninteger

The chart document's version: 0 until the workspace saves a chart, one higher with each save. A statement mapping states the version it was made under as chart_document_version.

rules_versioninteger

The version of the workspace's caption rules, which place printed captions on accounts: 0 until one is written, one higher with each change. A statement mapping states the version it was made under as chart_rules_version.

updated_atdatetime or nullOptional
When the chart document was last saved. Null until the workspace saves one.
active_export_systemstring or nullOptional

The workspace's active export system: the one whose map GET /api/chart-of-accounts/export-map returns and whose codes statement mappings carry. Null until an export map is saved.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error