Read-only quickstart

This quickstart reads your accounts. It does not record or change money.

1. Create a credential

Sign in to your Helm account and open Settings → API tokens. Create a named token with read:finance only. Store the shown secret in your integration’s server-side secret store.

Never paste the secret into a public issue, client bundle or screenshot.

2. Configure your integration

Set HELM_APP_ORIGIN to https://helm.neuroom.io for the public app, or the exact origin of your authorized development installation. Set HELM_API_TOKEN privately to the issued token.

These example variable names belong to your integration; they are not required application environment variables.

3. Make the request

curl "$HELM_APP_ORIGIN/api/v1/v2/accounts"   -H "Authorization: Bearer $HELM_API_TOKEN"   -H "Accept: application/json"

Use this in a private terminal where response financial data will not be captured in public logs. Do not add an option that forwards credentials across redirects.

4. Verify the result

Confirm the HTTP result and data envelope. Recognize one expected account and its currency. Helm may return system clearing accounts that support bookkeeping; these are excluded/nonmonetary foundation records, not your spendable money. If you have no ordinary user account yet, first set up one account, then repeat the read.

A 401 needs credential verification; a 403 needs scope/admission diagnosis; a 503 is unavailable rather than empty. Read errors.

5. Expand deliberately

Use examples to select the next read. Add only required scopes. Revoke the token when you retire the integration.