Skip to main content
HelloBooks.ai home
HelloBooks Developer Portal

Your books, programmable.

Connect your HelloBooks account to anything. Sign in, click once, and get an API key for your company — no application form, no review, no waiting.

Get an API KeyRead the Docs

Everything lives at developer.hellobooks.ai

How a request travelsHTTPS

Your software

Your own code, automation tools and workflows

Authorization: Bearer YOUR_API_KEY

HelloBooks API

/public/v1

scope checked on every request

Your company's books

One company, one entity — the ones you authorized

ReadWrite
Start building

How HelloBooks becomes programmable

The HelloBooks Developer Portal is where you build software that talks to HelloBooks — from a script that reads your own books to a product that connects to your customers' accounts.

One place for all of it, from your first API key to a support ticket.

  • API keys
  • Sandbox companies
  • API documentation
  • Code samples
  • Request logs
  • Webhooks and events
  • OAuth apps
  • Developer support
How it works

From sign-in to your first request

Four steps in the Developer Portal, then one request from your own software. There is no separate developer account to create.

  1. 1

    Sign in

    Sign in with an ordinary HelloBooks account.

  2. 2

    Create an API key

    Click Create API key.

  3. 3

    Choose your company

    Choose the organization and entity you want to authorize.

  4. 4

    Get your key

    The API key is generated and shown once.

  5. 5

    Call the API

    Use the key from your own software.

Your first request
curl https://<api-host>/public/v1/customers \
  -H "Authorization: Bearer YOUR_API_KEY"

No organization ID. No entity ID.

The API key already identifies the company you authorized, so the request does not need an organization ID or entity ID. Send the key as a Bearer token and call the endpoint.

Replace <api-host> with the API host from the docs, and YOUR_API_KEY with the key you were shown when you created it.

Developer features

What is in the Developer Portal

The tools you need to build an integration, test it safely and keep it running.

  • API Keys

    Create a key for one company without an application form or approval process.

    • No application form
    • No approval process
    • One company per key

  • Apps & OAuth

    For integrations that connect to other people's HelloBooks accounts, register an app and use OAuth so customers can authorize access themselves.

  • Sandbox

    India
    Use up to three practice companies containing realistic Indian accounting data, such as GST invoices, bills, and inventory.

  • API Docs

    API reference documentation, request and response examples, quickstart information, code samples, and documentation assistance.

  • Request Logs

    Every API call with its timestamp, status, and errors — plus a one-line explanation for each failed request.

  • Webhooks & Events

    Subscribe to events so your integration receives changes instead of repeatedly polling the API.

    Polling: ask the API again and again whether anything changed.

    Webhooks: receive the change when it happens.

  • Support

    Raise support tickets and follow them from the portal.
Security & scoping

A key that can only do one thing.

Each API key is bound to one company and one entity. It can read and write those books and no others. The scope is enforced on every request.

  • Keys are never stored in readable form.
  • A key is shown only when it is issued.
  • Reissuing a key immediately invalidates the old key.
  • Disconnecting revokes access.
  • API access does not grant permissions you did not already have.
  • Authorization is explicit and per-company.
One API keyScope checked on every request
  • The company and entity you authorizedRead & write
  • Another entityNo access
  • Another companyNo access
For software companies

Connecting other people's accounts?

An API key is for your own HelloBooks company. If your product connects to your customers' HelloBooks accounts, register an app and use OAuth instead — each customer authorizes access to their own company themselves.

API key

For your own HelloBooks company. You authorize it when you create the key.

App with OAuth

For other people's HelloBooks accounts. Each customer authorizes it themselves.

Read the OAuth docs
  1. 1Register an app.
  2. 2Receive OAuth credentials.
  3. 3Configure redirect URIs and scopes.
  4. 4Let your customers authorize access.
  5. 5Subscribe to webhooks for changes.

Start building.

A sandbox company and an API key, in the time it takes to read this page.

Open Developer PortalRead the Docs