API
Connect Inspec to your accounting software, automations and other tools with the Inspec API.
Overview
The Inspec API lets other software read your company's projects, schedules, suppliers, products, invoices and payments, add suppliers, and add to and edit your schedules. Common uses include syncing invoices and payments into your accounting software, building automations with tools like Zapier, and pulling your product library into other design tools, and keeping a schedule in step with a model in software like Revit.
Need the API to do more?
Email [email protected] and tell us what you want to connect. We add endpoints and fields when studios ask for them, and we're glad to hear what would help.
Keys are either read only or read and write. A read-only key can't change anything in your account. A read and write key can also add and change your data.
All requests go to:
https://api.inspec.design/v1Authentication
Creating an API key
Only admins can create API keys.
- Open API settings - Go to Settings and select API.
- Create a key - Click Create key and give it a name that describes where it will be used, for example "Zapier" or "Xero sync".
- Choose its access - Choose Read only for tools that only pull data out of Inspec. Choose Read and write only if the tool needs to add or change data in Inspec. You can't change this later, so create a new key if you need different access.
- Copy the key - Copy the key and store it somewhere safe. For security, it's only shown once.
You can revoke a key from the same page at any time, and anything using it will stop working immediately.
Keep your keys secret
Anyone with one of your keys can read your company's data, and a read and write key can also add to it and change it. Don't share keys by email or include them in website code. If a key is exposed, revoke it and create a new one.
Making requests
Send your key in the Authorization header of every request:
curl https://api.inspec.design/v1/me \
-H "Authorization: Bearer insp_your_key_here"The API is available to companies with an active subscription or trial.
Each key can make up to 120 requests a minute, shared across all endpoints. If you go over, you'll get a 429 with a Retry-After header.
Conventions
Pagination
List endpoints return a page of results and a cursor for the next page:
{
"data": [],
"nextCursor": "cm7x2k9lq0001abcd"
}| Parameter | Description |
|---|---|
limit | Results per page, from 1 to 100. Defaults to 50. |
cursor | The nextCursor from the previous page. |
updatedSince | Only return records updated at or after this time, e.g. 2026-03-01T09:00:00Z. A date on its own, like 2026-03-01, means midnight UTC. Write + in a timezone offset as %2B. |
Unknown parameters return a 400, so a typo can't silently change what you get back.
Results are ordered newest first. To get the next page, repeat the request with cursor set to nextCursor. When nextCursor is null, you've reached the last page. If the record a cursor points to is deleted while you're paging, you'll get a 400 invalid_request. Start again from the first page.
Syncing changes
To keep another system up to date, record the time you start each sync and pass it as updatedSince next time. You'll get the records that were created or changed in between.
updatedSince only returns records that are still in the list, so it won't tell you when something leaves it. For example, a deleted product or supplier, a deleted project along with its invoices and payments, or an invoice reopened as a draft along with its payments. To catch these, run a full sync without updatedSince from time to time and remove anything that's no longer returned.
Money
Amounts are whole numbers in the smallest unit of the currency (cents or pence), alongside a lowercase currency code. For example, "total": 125050 with "currency": "aud" is $1,250.50 AUD. Product costs and RRPs are always before tax.
Dates
- Timestamps such as
createdAtandupdatedAtare in UTC, e.g.2026-03-14T09:30:00.000Z. - Document dates such as an invoice date or payment date are written as
YYYY-MM-DDin your company's timezone, so they match the dates on your PDFs.
Creating records
Creating a record needs a read and write key. Send the record as a JSON object with a Content-Type: application/json header. Fields you leave out are left empty, and unknown fields return a 400, the same as unknown parameters. A request body can be up to 1 MB.
A successful request returns 201 with the new record, in the same shape you'd get from fetching it.
Some records must be unique, for example supplier names. Creating a duplicate returns a 409 conflict with the existing record's id in details.id. This makes it safe to retry a request that timed out: if the first attempt went through, the retry tells you where to find it.
Updating records
Updating a record also needs a read and write key. Send a PATCH request with a JSON object of only the fields you want to change. Anything you leave out stays as it is. Unknown fields return a 400.
A successful request returns 200 with the whole record, in the same shape you'd get from fetching it.
Sending a value the record already has changes nothing, so you can send everything you hold and let Inspec work out what is different.
Errors
Errors return a matching HTTP status and a body like this:
{
"error": {
"code": "not_found",
"message": "Invoice not found"
}
}| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A parameter or field is invalid or unknown. details lists each problem. |
| 401 | unauthorized | The key is missing, invalid or revoked. |
| 403 | subscription_required | Your company doesn't have an active subscription or trial. |
| 403 | insufficient_scope | The key doesn't have access to this endpoint, for example a read-only key creating a record. |
| 404 | not_found | The record or endpoint doesn't exist. |
| 405 | method_not_allowed | The endpoint doesn't support this HTTP method. |
| 409 | conflict | The record already exists, and details.id is the existing record's id. For schedule rows, a column was edited at the same moment, so send the request again. |
| 413 | payload_too_large | The request body is larger than 1 MB. Send less in each request. |
| 429 | rate_limited | Too many requests. Wait for the number of seconds in the Retry-After header. |
| 500 | internal_error | Something went wrong on our side. We're notified automatically. |
What's not included
Demo projects and invoices, and deleted projects and schedules, are never returned and can't be written to. Draft invoices are only returned when you ask for them (see Invoices).
Endpoints
Company
GET /v1/me
Returns the company your key belongs to. This is a good way to check that a key works.
{
"company": {
"id": "cm1a2b3c40000abcd",
"name": "Studio North",
"currency": "aud",
"timezone": "Australia/Sydney"
},
"apiKey": {
"id": "cm9z8y7x60000abcd",
"name": "Zapier",
"scopes": ["read"]
}
}scopes is ["read"] for a read-only key and ["read", "write"] for a read and write key.
Projects
GET /v1/projects
Lists your projects. Also accepts status (active or archived).
GET /v1/projects/{id}
Returns a single project.
{
"id": "cm2p0000000000abcd",
"name": "Bondi House",
"status": "active",
"currency": "aud",
"address": {
"line1": "12 Campbell Parade",
"line2": null,
"city": "Bondi Beach",
"state": "NSW",
"postcode": "2026",
"country": "Australia"
},
"client": {
"name": "Jane Smith",
"emails": ["[email protected]"],
"phone": "+61 400 000 000",
"address": {
"line1": "12 Campbell Parade",
"line2": null,
"city": "Bondi Beach",
"state": "NSW",
"postcode": "2026",
"country": "Australia"
}
},
"startDate": "2026-02-01",
"endDate": null,
"createdAt": "2026-01-15T03:12:45.000Z",
"updatedAt": "2026-03-02T22:01:10.000Z"
}Schedules
GET /v1/schedules
Lists the schedules in your active projects. Doesn't accept updatedSince. Also accepts:
| Parameter | Description |
|---|---|
projectId | Only schedules in this project. Works for archived projects too. |
projectStatus | active (the default) or archived, to list the schedules in your archived projects. |
{
"data": [
{
"id": "cm8s0000000000abcd",
"name": "Finishes Schedule",
"project": { "id": "cm2p0000000000abcd", "name": "Bondi House" },
"status": "For Construction",
"revision": {
"number": 3,
"label": "C",
"isLocked": true,
"lockedAt": "2026-03-02T22:01:10.000Z",
"issuedAt": "2026-03-03T01:15:00.000Z"
},
"createdAt": "2026-01-15T03:12:45.000Z"
}
],
"nextCursor": null
}statusis the schedule status, ornullif the schedule doesn't have one or your company has statuses turned off.revisionis the revision shown on the schedule in Inspec. A locked revision hasisLocked: trueand the time it was locked.issuedAtis when it was sent through Issue Report, ornullif it hasn't been.- While a schedule is unlocked for editing,
revisionis the one being worked on, withisLocked: falseand nolockedAtorissuedAt. For example, a schedule locked as Revision C becomes Revision D (number4) as soon as someone edits it. revisionisnullfor schedules with Revision Control turned off.
GET /v1/schedules/{id}
Returns a single schedule with its columns, sections and rows, as it is right now. That includes any edits made since the last locked revision.
To get a locked revision instead, add revision with its number, for example ?revision=2 for Revision B.
{
"id": "cm8s0000000000abcd",
"name": "Finishes Schedule",
"project": { "id": "cm2p0000000000abcd", "name": "Bondi House" },
"status": "For Construction",
"revision": {
"number": 3,
"label": "C",
"isLocked": true,
"lockedAt": "2026-03-02T22:01:10.000Z",
"issuedAt": null
},
"createdAt": "2026-01-15T03:12:45.000Z",
"currency": "aud",
"columns": [
{ "id": "cm8c0000000000code", "name": "Code", "type": "text" },
{
"id": "cm8c00000000finish",
"name": "Finish",
"type": "select",
"options": ["Honed", "Polished"]
},
{
"id": "cm8c0000000000spec",
"name": "Specification",
"type": "property",
"keys": ["Colour", "Grout"]
},
{ "id": "cm8c0000000000size", "name": "Size", "type": "dimension" },
{ "id": "cm8c000000000price", "name": "Price", "type": "price" }
],
"sections": [
{
"id": "cm8e00000000kitchen",
"name": "Kitchen",
"details": "All tiles laid in a stack bond",
"images": [
{
"url": "https://media.inspec.design/kitchen-plan.jpg",
"name": "kitchen-plan.jpg"
}
]
},
{ "id": "cm8e00000000laundry", "name": "Laundry", "details": null, "images": [] }
],
"rows": [
{
"id": "cm8r0000000000abcd",
"sectionId": "cm8e00000000kitchen",
"url": "https://coastaltiles.com/carrara-hexagon",
"productId": "cm6d0000000000abcd",
"attachments": [
{
"id": "cm8a0000000000abcd",
"name": "Spec sheet.pdf",
"url": "https://media.inspec.design/spec-sheet.pdf",
"size": 482113
}
],
"cells": {
"cm8c0000000000code": "FL-01",
"cm8c00000000finish": "Honed",
"cm8c0000000000spec": { "Colour": "White", "Grout": "Mapei 100" },
"cm8c0000000000size": { "width": 300, "depth": 10, "height": 300, "unit": "mm" },
"cm8c000000000price": { "quantity": 24, "unitCost": 8950 }
}
}
]
}rowsare in the order the schedule shows them, and each row'ssectionIdis the section it sits in. Sections with no rows are still listed insections.cellshas a value for every column, keyed by the column'sid.urlis the row's link, andproductIdis the product in your product library that the row is linked to. Either can benull.- Row comments aren't included.
The value of a cell depends on its column's type:
| Type | Value |
|---|---|
text | Plain text, or null. Line breaks are kept. Formatting such as bold and links isn't included. |
select | The name of the chosen option, or null. The column lists its options. |
multi_select | A list of option names. |
property | An object of property names to values, e.g. { "Colour": "White" }. The column lists its keys. |
dimension | width, depth and height in millimetres (each can be null), or null if none are set. |
image | url, name and caption, or null. |
supplier | The supplier's name, or null. |
price | quantity and unitCost, or null. unitCost is before tax, in the smallest unit of the currency. |
status | draft, for_review, client_approved or client_rejected. |
With revision, the rows and cell values are the ones that were locked, and revision and status describe that revision. Column names, section details, links and attachments are the current ones. If the schedule has no locked revision with that number, you'll get a 404.
POST /v1/schedules/{id}/sections
Adds a section to the end of a schedule. Needs a read and write key. The response is the new section, in the same shape as in the schedule above.
curl https://api.inspec.design/v1/schedules/cm8s0000000000abcd/sections \
-H "Authorization: Bearer insp_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "name": "Ensuite", "details": "All tiles laid in a stack bond" }'{
"id": "cm8e00000000ensuite",
"name": "Ensuite",
"details": "All tiles laid in a stack bond",
"images": []
}| Field | Description |
|---|---|
name | Required. Up to 100 characters. |
details | Optional. Up to 1,000 characters. |
POST /v1/schedules/{id}/rows
Adds a row to the end of a section. Needs a read and write key. The response is the new row, in the same shape as in the schedule above, with a value for every column.
curl https://api.inspec.design/v1/schedules/cm8s0000000000abcd/rows \
-H "Authorization: Bearer insp_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"sectionId": "cm8e00000000kitchen",
"url": "https://coastaltiles.com/carrara-hexagon",
"cells": {
"cm8c0000000000code": "FL-02",
"cm8c00000000finish": "Honed",
"cm8c0000000000spec": { "Colour": "White", "Grout": "Mapei 100" },
"cm8c0000000000size": { "width": 300, "depth": 10, "height": 300 },
"cm8c000000000price": { "quantity": 24, "unitCost": 8950 }
}
}'| Field | Description |
|---|---|
sectionId | Required. The section to add the row to. |
url | Optional. The row's link, up to 2,000 characters. A link without http:// or https:// is saved with https://. |
cells | Optional. Values keyed by column id, in the shapes listed under Writing cell values. |
Columns you leave out of cells start empty. Rows don't have to be unique, so sending the same request twice adds two rows.
PATCH /v1/schedules/{id}/rows/{rowId}
Updates a row. Needs a read and write key. Send url, cells, or both. Only the columns you name in cells change. The response is the whole row.
curl -X PATCH https://api.inspec.design/v1/schedules/cm8s0000000000abcd/rows/cm8r0000000000abcd \
-H "Authorization: Bearer insp_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "cells": { "cm8c00000000finish": "Polished" } }'- A value that matches what the cell already holds is left alone. The cell isn't marked as changed in the next revision, and formatting such as bold in a text cell is kept.
- Editing a schedule with a locked revision starts the next revision, the same as editing it in Inspec. Changing only a row's
urldoesn't. - Set
urltonullto remove the row's link. - You'll get a 404 if the row has been deleted or belongs to a different schedule.
POST /v1/schedules/{id}/rows/bulk
Adds and updates up to 100 rows in one request. Needs a read and write key. Each item in create takes the same fields as adding a row, and each item in update takes a row id plus the same fields as updating a row.
curl https://api.inspec.design/v1/schedules/cm8s0000000000abcd/rows/bulk \
-H "Authorization: Bearer insp_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"sectionId": "cm8e00000000kitchen",
"cells": { "cm8c0000000000code": "FL-02" }
}
],
"update": [
{
"id": "cm8r0000000000abcd",
"cells": { "cm8c00000000finish": "Polished" }
}
]
}'{
"created": [{ "id": "cm8r0000000000wxyz", "sectionId": "cm8e00000000kitchen" }],
"updated": [{ "id": "cm8r0000000000abcd", "sectionId": "cm8e00000000kitchen" }]
}- The response is
200with the whole rows, shortened here, in the order you sent them. - Either every row is saved or none is. If any row is invalid you'll get a 400, and
detailspoints to each problem, for exampleupdate.0.cells.cm8c00000000finish. createandupdatecan hold up to 100 rows between them, and the request body can be up to 1 MB. Send more in further requests.- A row can only appear once in
update. A row that has been deleted or belongs to a different schedule returns a 400 here.
Writing cell values
Cell values are sent in the same shapes they're returned in, so a value you fetched can be sent straight back.
| Type | Value to send |
|---|---|
text | Plain text of up to 10,000 characters, or null to clear it. Line breaks are kept. Spaces at the start and end of each line are removed, and repeated spaces become one. |
select | The name of an option, or null to clear it. Case and surrounding spaces are ignored. A name the column doesn't have is added as a new option. |
multi_select | A list of option names, matched the same way. [] or null clears it. |
property | An object of property names to values. Only the properties you name change. A value sets the property, and null or "" removes it. A name the column doesn't have is added as a new property. null for the whole value clears it. |
dimension | Any of width, depth and height in millimetres. Sides you leave out are kept, and null clears a side. null for the whole value clears it. You can include "unit": "mm", but no other unit. |
price | quantity, unitCost, or both. unitCost is before tax, in the smallest unit of the currency. The one you leave out is kept, and a new price starts at a quantity of 1 and a unit cost of 0. null clears the price. |
supplier | The supplier's name, or null to clear it. A name none of your suppliers has creates a new supplier. |
image, status | Can't be set through the API. Sending a value returns a 400. |
A supplier name is matched against your suppliers ignoring case, the same as when creating a supplier, so "coastal tiles" finds "Coastal Tiles". If no supplier has that name, one is created. The cell is saved with the supplier's own name, so its capitals can differ from what you sent. A supplier created this way is kept even if the request then fails with a 409 or a 500, and sending the request again uses it.
Option and property names can be up to 100 characters, and property values up to 2,000. A column can have up to 500 options or properties, and a request that would add more returns a 400. A column id that isn't in the schedule returns a 400 too.
If someone edits a column in Inspec at the same moment your request adds an option or property to it, you'll get a 409 conflict. No rows are saved, so send the request again.
Suppliers
GET /v1/suppliers
Lists your suppliers.
GET /v1/suppliers/{id}
Returns a single supplier.
{
"id": "cm3s0000000000abcd",
"name": "Coastal Tiles",
"email": "[email protected]",
"phone": "02 9000 0000",
"website": "https://coastaltiles.com",
"notes": null,
"tradeDiscountPercentage": 15,
"address": {
"line1": "4 Harbour Road",
"line2": null,
"city": "Alexandria",
"state": "NSW",
"postcode": "2015",
"country": "Australia"
},
"contacts": [
{
"id": "cm3c0000000000abcd",
"name": "Sam Lee",
"email": "[email protected]",
"phone": null,
"notes": "Trade account manager"
}
],
"tags": ["Stone", "Tiles"],
"createdAt": "2025-11-04T01:20:00.000Z",
"updatedAt": "2026-02-18T05:44:31.000Z"
}POST /v1/suppliers
Creates a supplier. Needs a read and write key. The body uses the same fields as the supplier above, and the response is the new supplier.
curl https://api.inspec.design/v1/suppliers \
-H "Authorization: Bearer insp_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"name": "Coastal Tiles",
"email": "[email protected]",
"tradeDiscountPercentage": 15,
"address": { "city": "Alexandria", "state": "NSW" },
"contacts": [{ "name": "Sam Lee", "email": "[email protected]" }],
"tags": ["Stone", "Tiles"]
}'| Field | Description |
|---|---|
name | Required. Up to 100 characters, and unique within your company. |
email, phone, website, notes | Optional. |
tradeDiscountPercentage | Optional whole number from 0 to 100. |
address | Optional. Any of line1, line2, city, state, postcode and country. |
contacts | Optional list of up to 50 contacts, each with a name and optional email, phone and notes. |
tags | Optional list of up to 20 tag names. Tags that don't exist yet are created. |
If a supplier with the same name already exists, you'll get a 409 conflict with its id in details.id. Names are matched ignoring case, so "Coastal Tiles" and "coastal tiles" count as the same supplier.
Products
GET /v1/products
Lists the products in your product library. Also accepts supplierId.
GET /v1/products/{id}
Returns a single product.
{
"id": "cm6d0000000000abcd",
"name": "Carrara Hexagon Mosaic",
"supplier": { "id": "cm3s0000000000abcd", "name": "Coastal Tiles" },
"url": "https://coastaltiles.com/carrara-hexagon",
"notes": null,
"currency": "aud",
"cost": 8950,
"rrp": 12900,
"imageUrl": "https://media.inspec.design/example.jpg",
"isFavourite": true,
"tags": ["Bathroom"],
"fields": [
{ "name": "Finish", "type": "select", "value": "Honed", "text": "Honed" },
{
"name": "Size",
"type": "dimension",
"value": { "width": 300, "depth": 10, "height": 300, "unit": "mm" },
"text": "W 300mm × D 10mm × H 300mm"
}
],
"attachments": [
{
"id": "cm6a0000000000abcd",
"name": "Spec sheet.pdf",
"url": "https://media.inspec.design/spec-sheet.pdf",
"size": 482113
}
],
"createdAt": "2026-01-20T07:00:00.000Z",
"updatedAt": "2026-01-20T07:00:00.000Z"
}Each field has a text version of its value, formatted with your company's measurement unit. The value depends on the field's type:
| Type | Value |
|---|---|
text, select, supplier | A string, or null. |
multi_select | A list of strings. |
property | An object of property names to values, e.g. { "Colour": "White" }. |
dimension | width, depth and height in millimetres (each can be null). |
image | url, name and caption. |
price | quantity and unitCost (in the smallest currency unit, before tax). |
text is empty for image, price and supplier fields.
Invoices
GET /v1/invoices
Lists invoices and credit notes. Only sent ones are returned unless you set status. Also accepts:
| Parameter | Description |
|---|---|
projectId | Only invoices for this project. |
type | invoice or credit_note. |
paymentStatus | unpaid, paid or on_account. |
status | sent (the default), draft or archived. Archived invoices were cancelled before being sent. |
GET /v1/invoices/{id}
Returns a single invoice, including its payments.
{
"id": "cm4i0000000000abcd",
"number": 42,
"displayNumber": "INV-0042",
"type": "invoice",
"kind": "itemised",
"status": "sent",
"paymentStatus": "paid",
"reference": "Kitchen joinery",
"invoiceDate": "2026-03-01",
"project": { "id": "cm2p0000000000abcd", "name": "Bondi House" },
"currency": "aud",
"subtotal": 1000000,
"tax": 100000,
"total": 1100000,
"creditApplied": 0,
"amountDue": 1100000,
"taxBreakdown": [{ "name": "GST", "percentage": 10, "amount": 100000 }],
"createdAt": "2026-02-27T23:15:00.000Z",
"updatedAt": "2026-03-10T04:02:12.000Z",
"payments": [
{
"id": "cm5p0000000000abcd",
"invoice": { "id": "cm4i0000000000abcd", "displayNumber": "INV-0042" },
"projectId": "cm2p0000000000abcd",
"date": "2026-03-10",
"method": "Bank transfer",
"notes": null,
"origin": "standard",
"currency": "aud",
"amount": 1100000,
"isReversed": false,
"reversedAt": null,
"createdAt": "2026-03-10T04:02:12.000Z",
"updatedAt": "2026-03-10T04:02:12.000Z"
}
]
}kindisitemised,instalmentordesign_fees.amountDueis thetotalminus anycreditAppliedfrom the client's credit on file.- Credit notes have negative amounts and a
displayNumberlikeCN-0003. Apaidcredit note was refunded to the client, and anon_accountcredit note was kept as credit on the client's account. - Drafts are still being prepared, so their lines and totals can change until they're sent. Avoid importing them into your accounting software. A draft's totals can also change without its
updatedAtchanging, for example when the project's tax rate or fees are edited, so fetch drafts again rather than relying onupdatedSince.
Payments
GET /v1/payments
Lists client payments against sent invoices. Also accepts invoiceId and projectId. Each payment has the same shape as in the invoice example above.
amountis the cash the payment settled. Refunds of credit notes are negative.originisstandardfor payments you recorded,credit_on_filewhen the invoice was paid from the client's credit, andon_accountwhen a credit note was kept on account. Onlystandardpayments move money, so the others have anamountof 0.- Reversed payments are included with
isReversed: trueand anamountofnull. Leave them out when adding up totals. Reopening an invoice as a draft reverses its payments and moves them out of this list, so they only appear on the invoice itself.