Skip to main content
The PRINTOOLS API lets another system read and write your shop’s data — pushing orders in from a storefront, pulling jobs into a dashboard, syncing invoices out to accounting.

​
Mint a key

Settings → API → New key. Name it after the thing that will use it, pick the scopes it needs, and copy the key immediately.
The key is shown once. It is stored as a hash, so nobody — not you, not support — can recover it later. If you lose it, revoke it and mint a replacement.
Scopes are fixed when the key is minted. To change what a key can do, mint a new one and revoke the old. The list shows each key by its first twelve characters so you can tell them apart.

​
Grant the least it needs

A read scope reads. A write scope creates, updates and deletes — quotes.write includes deleting quotes. Three actions sit outside write so you can grant the ordinary work without the dangerous part:

​
Make your first call

Every request carries two headers: the key, and the organisation the key belongs to.
GET /v1/me needs no scope, so it works with any valid key. It returns your org, the credential, and the scopes it was granted — the fastest way to confirm a key is live.

​
Then

API introduction

Base URLs and how the API relates to the app.

Authentication

Headers, and the four reasons a 401 happens.