> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oncanary.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Build with Canary

> Connect maintenance work, equipment, meters, inventory, and external systems

# 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

<CardGroup cols={2}>
  <Card title="Make the first request" icon="rocket" href="/quickstart">
    Create a key and verify the connection in curl, JavaScript, or Python.
  </Card>

  <Card title="Choose scopes" icon="key-round" href="/authentication">
    Give each integration the smallest set of resource permissions it needs.
  </Card>

  <Card title="Understand the resource model" icon="boxes" href="/api-reference/resource-model">
    See how requests, work orders, assets, locations, meters, parts, and identifiers connect.
  </Card>

  <Card title="Browse the API" icon="braces" href="/api-reference/overview">
    Use the generated endpoint reference for current request and response schemas.
  </Card>
</CardGroup>

## Production base URL

```text theme={"theme":"github-light"}
https://api.oncanary.com/v1
```

Every request uses HTTPS and a Bearer API key:

```bash theme={"theme":"github-light"}
curl --fail-with-body "https://api.oncanary.com/v1/assets?limit=1" \
  --header "Authorization: Bearer $CANARY_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

| Goal                                    | Start with                                  |
| --------------------------------------- | ------------------------------------------- |
| Synchronize equipment                   | Assets, locations, parts, and custom fields |
| Send maintenance work into Canary       | Work orders                                 |
| Review requests and turn them into work | Work requests plus work-order approval      |
| Ingest machine usage                    | Meters and meter readings                   |
| Connect barcode or QR scanners          | Identifiers                                 |

<Note>
  Canary-native resources and MaintainX-compatible resources use different success envelopes. Read [Response conventions](/api-reference/overview#response-conventions) before building a shared client.
</Note>

## Contract and support

* [Download the OpenAPI 3.1 document](/openapi.yaml)
* [Read integration patterns](/guides/integration-patterns)
* [Check API errors](/guides/errors)
* Contact [support@oncanary.com](mailto:support@oncanary.com) with the `X-Request-ID` from a failed call