Skip to main content

​
Build with Canary

The Canary REST API gives integration teams a scoped interface to the records that move maintenance work forward. Create and update work orders, receive work requests, synchronize equipment and inventory records, record meter readings, and resolve scannable identifiers.

​
Start here

Make the first request

Create a key and verify the connection in curl, JavaScript, or Python.

Choose scopes

Give each integration the smallest set of resource permissions it needs.

Understand the resource model

See how requests, work orders, assets, locations, meters, parts, and identifiers connect.

Browse the API

Use the generated endpoint reference for current request and response schemas.

​
Production base URL

Every request uses HTTPS and a Bearer API key:
The public API is a deliberate integration surface within Canary. The generated reference is the source of truth for available resources and operations.

​
Common integration paths

Canary-native resources and MaintainX-compatible resources use different success envelopes. Read Response conventions before building a shared client.

​
Contract and support

Make your first request

Connect to the Canary API with curl, JavaScript, or Python

Authentication and scopes

Create, protect, and scope Canary API keys

API overview

Base URL, response conventions, headers, and the generated Canary API reference