Skip to content

The Primemgr REST API

Read and write your workspace from your own tools: customers, jobs, quotes, invoices, payments, bookings, items, time, sites, leads and more.

Updated

The Primemgr API lets your own systems work with your workspace: an accounting export, a dashboard, a website form that creates a customer.

What it covers

Customers and assets can be listed, read, created, updated and deleted. Jobs (work orders) can be created and updated, with status changes going through the same workflow rules as the screens. Quotes can be created as drafts with their lines (sending and acceptance stay in the app), invoices made from an accepted quote or a job, payments recorded and allocated as they would be by hand, bookings made against your opening hours and availability, price-list items created and updated, and time entries added. Sites, leads, opportunities, service agreements, bookable services, suppliers and purchase orders can be listed and read.

Keys that can only do what you allow

Create an API key in Settings and choose exactly what it may do. A key that can read invoices cannot create customers. Keys use the same permissions as your team, and can be revoked at any time.

Built to be safe to retry

Writes accept an Idempotency-Key, so a request repeated after a timeout does not create a second record. Lists are paged with a cursor, and every request is recorded in your workspace’s API access log.

Documented

The API is described by an OpenAPI 3.1 document, generated from the same definitions the API itself uses, so the documentation cannot drift from the behaviour.

Related

Ready to try it on a real job?

Fourteen days on the plan you choose, a reminder before the first charge, and an export of everything you put in if you decide against it.

Start free trial