API
Your data is yours, and you can get at it from your own software. This is the API you build a connector against. It's separate from the one our own apps use, so it doesn't change under you when we redesign a screen.
What you can reach today
Contacts and products, read and write. Invoices, quotes and payments aren't published yet. If you're waiting on those, tell us what you're building - it shapes the order we do them in.
Your first call
Make a key under Settings, then API keys, and ask for your own contacts back.
curl https://app.obraledger.com/api/public/v1/contacts \
-H "X-AUTH-TOKEN: obl_live_..."Rather fill it in and press a button? Try a call in the browser.
What's in it
Contacts
The people and companies you sell to. Everything a quote or an invoice needs to name somebody, and the addresses it prints.
get get post patch delete
Products
What you sell, and what you keep on the shelf. Prices come back as decimal strings, so they arrive with their cents intact.
get get post patch delete
Where to go next
- Getting a key, and what it can do
How keys are made, what a key can never do, and why we can't read yours back to you.
- How the API behaves
Paging, picking up only what changed, money, retries, and what happens when we add a field.
- Every error, and what to do about it
The address in a failed response opens a page. That's on purpose.
- Try a call
Build the request, see what comes back, or take the line away and run it yourself.
Version 1.0.0. 10 calls across 2 resources. The machine-readable contract is at openapi.json, and every page here is generated from it.
Building something and stuck? Tell us - we'd rather hear it than have you guess.