Equipment & Assets

For how this area works day to day, see the Equipment & assets guide.

Webhook events: maintenance.due, work_order.created, work_order.updated, work_order.closed. See Webhooks.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

• GET/assets

  List assets

  Keyequipment:read

  Peopleequipment.read

  Featureequipment
• POST/assets

  Create an asset

  Keyequipment:write

  Peopleequipment.manage

  Featureequipment
• GET/assets/external/{externalId}

  Get an asset by external ID

  Keyequipment:read

  Peopleequipment.read

  Featureequipment
• PUT/assets/external/{externalId}

  Create or replace an asset by external ID

  Keyequipment:write

  Peopleequipment.manage

  Featureequipment
• GET/assets/{id}

  Get an asset

  Keyequipment:read

  Peopleequipment.read

  Featureequipment
• PATCH/assets/{id}

  Update an asset (partial)

  Keyequipment:write

  Peopleequipment.manage

  Featureequipment
• DELETE/assets/{id}

  Archive an asset

  Keyequipment:write

  Peopleequipment.manage

  Featureequipment
• POST/assets/{id}/meter-readings

  Record a meter reading (hours, km…)

  Keyequipment:write

  Peopleequipment.manage

  Featureequipment
• POST/assets/{id}:maintained

  Record that maintenance was done

  Keyequipment:write

  Peopleequipment.manage

  Featureequipment.maintenance
• GET/maintenance/due

  Assets due for maintenance by date or meter

  Keyequipment:read

  Peopleequipment.read

  Featureequipment.maintenance
• GET/work-orders

  List work orders

  Keyequipment:read

  Peopleequipment.read

  Featureequipment.work_orders
• POST/work-orders

  Create a work order

  Keyequipment:write

  Peoplework_orders.create

  Featureequipment.work_orders
• GET/work-orders/external/{externalId}

  Get a work order by external ID

  Keyequipment:read

  Peopleequipment.read

  Featureequipment.work_orders
• PUT/work-orders/external/{externalId}

  Create or replace a work order by external ID

  Keyequipment:write

  Peoplework_orders.manage

  Featureequipment.work_orders
• GET/work-orders/{id}

  Get a work order

  Keyequipment:read

  Peopleequipment.read

  Featureequipment.work_orders
• PATCH/work-orders/{id}

  Update a work order (partial)

  Keyequipment:write

  Peoplework_orders.manage

  Featureequipment.work_orders