Your first call in two minutes

You need a Bizisy company and a login in it. In two minutes you'll have an API key, a working request and the answer to "who am I?".

1. Create an API key#

Sign in to your company (https://<company>.bizisy.com) and create a key:

• In Manage (owners, admins, HR and viewers): Settings → API keys, choose Manage, name it and create it.
• In the employee app (everyone): Connect AI → API keys, which creates a Me key.

Copy the key when it's shown: Bizisy shows the secret once and keeps only a fingerprint of it. It looks like hrk_01k6…_Xp3… (API keys explains Manage and Me keys).

export BIZISY_API_KEY='hrk_…'

2. Call the API#

Every action is a POST with a JSON body to https://api.bizisy.com/v1/<module>/<action>. Ask who you are:

curl https://api.bizisy.com/v1/platform/whoami \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const res = await fetch('https://api.bizisy.com/v1/platform/whoami', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.BIZISY_API_KEY}`, 'Content-Type': 'application/json' },
  body: '{}',
});
console.log(await res.json());

import os
import requests

res = requests.post(
    "https://api.bizisy.com/v1/platform/whoami",
    headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
    json={},
)
print(res.json())

3. Read the result#

A successful call answers 200 with the result under data:

{
  "data": {
    "user": { "id": "usr1", "email": "ana@acme.test", "display_name": "Ana Ferreira", "language": null },
    "org": { "id": "o1", "slug": "acme", "name": "Acme Lda", "language": "pt-PT" },
    "roles": ["owner"],
    "audiences": ["me", "manage"],
    "person_id": "p1",
    "billing": true,
    "documents": true,
    "paused": null
  }
}

The key decides the company: there is no company id to send. roles is your role, and person_id is your own person record.

Something else came back? A 401 means the key is missing, mistyped or revoked; every error has a code, a message and usually a hint (Errors).

4. Read your people#

curl https://api.bizisy.com/v1/org/people.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q": "ana"}'

Read actions also answer GET with the input as query parameters, which is handy for quick reads from a terminal or a tool like Postman:

curl "https://api.bizisy.com/v1/org/people.list?q=ana" -H "Authorization: Bearer $BIZISY_API_KEY"

Next#

• Before your first change, read Dry runs: add ?dry_run=true and nothing is saved.
• Make retries safe with an Idempotency-Key.
• Browse the API reference, or import the OpenAPI file into Postman, Insomnia or a client generator.