Quickstart

Create an API key

In BeanRails, open Settings and go to API Keys. Click Create, name the key after the system that will use it, and choose the scopes it needs. See Authentication for what each scope allows.Copy the key when it is shown. BeanRails stores only a hash of it, so you cannot see it again.

You need to be the workspace owner, or have a role that allows creating API keys.

List your contacts

Send the key as a bearer token. Replace {host} with the host your BeanRails workspace is served from.

curl "https://{host}/api/public/v1/contacts?limit=5" \
  -H "Authorization: Bearer brk_live_your_key_here" \
  -H "Accept: application/json"

const res = await fetch("https://{host}/api/public/v1/contacts?limit=5", {
  headers: {
    Authorization: "Bearer brk_live_your_key_here",
    Accept: "application/json"
  }
});
const { data, meta } = await res.json();

import requests

res = requests.get(
    "https://{host}/api/public/v1/contacts",
    params={"limit": 5},
    headers={"Authorization": "Bearer brk_live_your_key_here"},
)
contacts = res.json()["data"]

Create a contact

This needs the contacts:write scope.

curl -X POST "https://{host}/api/public/v1/contacts" \
  -H "Authorization: Bearer brk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "company_name": "Acme Trading Sdn Bhd",
    "email": "accounts@acme.example",
    "addresses": [{ "name": "Head office", "address1": "1 Jalan Example", "is_primary": true }]
  }'

The response contains the new contact under data. Keep its id: you use it to create works and invoices for this customer.

Getting started

Essentials

Next steps

Authentication

Conventions

​Next steps

Authentication

Conventions

Next steps