Skip to content

You are reading version v1.2, which is archived. See the current version

BIRP API

Guides and reference for the BIRP API: authenticate with a company key, then read and write products, customers, orders, invoices and stock over HTTPS.

GET /v1/me
curl "https://api.birp.io/v1/me" \
  -H "Authorization: Bearer $BIRP_API_KEY"

The samples read your key from BIRP_API_KEY.

Start here

  1. 1Create your first keyCreate an API key in BIRP, choose its scopes and expiry, and copy it once.
  2. 2Make your first requestCall GET /v1/me with your key, read the answer, then list your first products.
  3. 3ResourcesMe and tax codes, Products, Categories, Customers, Warehouses and stock, Orders, Invoices and payments, External references

Everything in this version

Sandbox

Try any operation from its block with Try it: the answer is built in your browser from the documented examples, and nothing reaches BIRP.