Getting Started with the API

BusinessHRM ships with a full REST API so you can read and write your workspace data from scripts, automation platforms (Zapier, Make, n8n), or your own applications. Everything you can do in the app — manage contacts, projects, tasks, invoices, employees, attendance, leaves, tickets and more — is available over the API.

Where to find it›API Keys (in the app), and the interactive documentation at https://app.businesshrm.com/developers.

What you get

Endpoint	What it is
`https://app.businesshrm.com/api/v1`	The base URL for every REST API call.
`https://app.businesshrm.com/developers`	Interactive API documentation — browse every endpoint, see request/response shapes, and try calls live in your browser.
`https://app.businesshrm.com/developers/openapi.json`	The machine-readable OpenAPI spec. Import it into Postman, Insomnia, code generators, or your own tooling.
`https://app.businesshrm.com/developers/llms.txt`	A plain-text summary of the API designed to be pasted into AI assistants.

Note: If your workspace uses a custom subdomain (for example https://acme.businesshrm.com), you can use that host in place of app.businesshrm.com everywhere in these articles.

The interactive documentation

The interactive docs at /developers are the best place to explore the API. They are generated directly from the live API, so they always match what your workspace actually supports. For each endpoint you can see:

The HTTP method and path (for example GET /contact, POST /task).
Every parameter, with descriptions and which ones are required.
Example requests and responses.
A Try it panel where you can paste an API key and run the call against your real data.

You can also reach the docs from inside the app: open Settings → API Keys and click View Docs.

Three steps to your first request

Create an API key. Go to Settings → API Keys and create a key. Copy it immediately — it is shown only once. See API Keys for the full walkthrough.

Make a request. Send the key as a Bearer token in the Authorization header:

curl https://app.businesshrm.com/api/v1/contact \
  -H "Authorization: Bearer YOUR_API_KEY"

Read the response. All responses are JSON. From here, browse the interactive docs to discover the other endpoints.

Tip: Want an AI assistant to use the API for you instead of writing code? See Connect MCP with Claude and other AI assistants.

Next steps

API Keys — create and manage the keys that authenticate your requests.
REST API Basics — pagination, choosing fields, sorting, filtering and error handling.
Connect MCP with Claude and other AI assistants — give AI tools direct access to your workspace.