Limble CMMS Routes API

The Routes API from Limble CMMS — 120 operation(s) for routes.

Operations 212

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/me Check which customer and plan my API keys belong to · Me #
Ask an LLM
“Which Limble customer account are my API keys authenticated as?”
“What plan is my CMMS account subscribed to, and is it a deprecated legacy plan?”
Tell an agent
Test that my API credentials work and tell me the customer name.
Show the subscription plan tied to these API keys.
PUT /v2/assets/{assetID}/image Set the main image for an asset · Add Asset Main Image #
Ask an LLM
“Can I upload a main photo for a piece of equipment?”
“How do I set the primary picture shown on an asset record?”
Tell an agent
Upload a new main image for asset {assetID}.
Set the main photo on asset {assetID}.
DELETE /v2/assets/{assetID}/image Remove an asset's main image · Delete Asset Main Image #
Ask an LLM
“How can I take the main photo off an asset?”
“Is it possible to clear an equipment record's primary picture?”
Tell an agent destructive · confirm first
Remove the main image from asset {assetID}.
Delete the primary photo on asset {assetID}.
GET /v2/assets/fields List custom field values on assets · Asset Fields #
Ask an LLM
“What values are stored in the Make, Model and other custom fields on my assets?”
“Can I filter asset field values by field type or by the value itself?”
Tell an agent
Show the field values for assets {assets}.
List asset field values where the field is named {name}.
POST /v2/assets/fields Create a new suggested field for assets · New Asset Suggested Field #
Ask an LLM
“Can I add a new custom field option that assets at a location can use?”
“What does it take to define a new suggested asset field like Serial Number?”
Tell an agent
Create a new suggested asset field for a location.
Add a custom field to the list of suggested fields available to assets.
GET /v2/assets/fields/suggested List suggested fields available to assets · Asset Suggested Fields #
Ask an LLM
“Which fields can an asset choose from when setting up its fields?”
“What suggested fields exist for assets at each of my locations?”
Tell an agent
List the suggested asset fields at locations {locations}.
Show the suggested asset field named {name}.
GET /v2/assets/fields/history Get the change history of asset field values · Asset Field History #
Ask an LLM
“How have an asset's field values changed over time?”
“Can I see trends in a meter reading field across my equipment?”
Tell an agent
Pull the field value history for assets {assets}.
Show the history of asset field {fields} between {start} and {end}.
PUT /v2/assets/{assetID}/fields Attach a suggested field to an asset · Attach Field to Asset #
Ask an LLM
“How do I add the Make field to an asset that doesn't have it yet?”
“Must a field and an asset be at the same location before I can attach it?”
Tell an agent
Attach a suggested field to asset {assetID}.
Add an existing custom field to equipment record {assetID}.
DELETE /v2/assets/fields/{valueID} Remove a field from an asset · Delete Asset Field #
Ask an LLM
“Can I detach a custom field that was attached to an asset?”
“How do I remove an unwanted field from one piece of equipment?”
Tell an agent destructive · confirm first
Delete asset field value {valueID}.
Remove the attached asset field with value ID {valueID}.
PATCH /v2/assets/fields/{valueID} Update the value of an asset's field · Update Asset Field Value #
Ask an LLM
“How do I change the value stored in an asset's custom field?”
“Can I set a truck's Make field to Dodge through the API?”
Tell an agent
Update the value of asset field {valueID}.
Change the stored asset field value {valueID} to a new reading.
DELETE /v2/assets/logs/file/{fileID} Delete a file attached to an asset log · Delete Asset Log File #
Ask an LLM
“Can I remove an attachment from an asset log entry?”
“How do I delete a file that was uploaded to an equipment log?”
Tell an agent destructive · confirm first
Delete asset log file {fileID}.
Remove the attachment {fileID} from its asset log.
PUT /v2/assets/{assetID}/logs/{logID}/file Attach a file to an asset log · Add Asset Log File #
Ask an LLM
“Can I attach a document or photo to an asset log entry?”
“What ID do I get back after adding a file to an equipment log?”
Tell an agent
Attach a file to log {logID} on asset {assetID}.
Upload a photo to asset {assetID}'s log entry {logID}.
GET /v2/assets/{assetID}/logs List log entries for an asset · Asset Logs #
Ask an LLM
“What has been logged against a specific asset, manually or automatically?”
“Can I search an asset's log entries by text or by the user who wrote them?”
Tell an agent
Show the logs for asset {assetID}.
List asset {assetID} log entries containing {logEntry}.
POST /v2/assets/{assetID}/logs Add a manual log entry to an asset · New Asset Log #
Ask an LLM
“How do I write a manual note into an asset's log?”
“Can I record who wrote an asset log entry?”
Tell an agent
Add the log entry {logEntry} to asset {assetID}.
Log {logEntry} on asset {assetID} as user {userID}.
PATCH /v2/assets/logs/{logID} Edit a manual asset log entry · Update Asset Log #
Ask an LLM
“Can I correct the text of a manual log entry on an asset?”
“How do I edit a note already written into an asset's log?”
Tell an agent
Change the text of asset log {logID} to {logEntry}.
Update manual asset log entry {logID}.
DELETE /v2/assets/logs/{logID} Delete a manual asset log entry · Delete Asset Log #
Ask an LLM
“Can I delete a manual log entry I made on an asset?”
“Is it possible to remove a mistaken note from equipment history?”
Tell an agent destructive · confirm first
Delete asset log {logID}.
Remove manual asset log entry {logID}.
GET /v2/assets/fields/{fieldID}/options List options of an asset dropdown field · Get Asset Dropdown Field Options #
Ask an LLM
“What choices are available in an asset dropdown field?”
“Which options can I pick for an asset's dropdown custom field?”
Tell an agent
Show the options for asset dropdown field {fieldID}.
List choices of asset field {fieldID}.
POST /v2/assets/fields/{fieldID}/options Append options to an asset dropdown field · Append Asset Dropdown Field Option(s) #
Ask an LLM
“How do I add new choices to an asset dropdown field without losing existing ones?”
“What happens if I append a duplicate option to an asset field?”
Tell an agent
Append options to asset dropdown field {fieldID}.
Add new choices to asset field {fieldID}, keeping the existing ones.
PUT /v2/assets/fields/{fieldID}/options Replace all options of an asset dropdown field · Replace Asset Dropdown Field Options #
Ask an LLM
“Can I overwrite the entire option list of an asset dropdown field?”
“What happens to existing asset dropdown options when I replace them?”
Tell an agent destructive · confirm first
Replace the options of asset dropdown field {fieldID} with {options}.
Overwrite asset field {fieldID} choices with {options}.
DELETE /v2/assets/fields/{fieldID}/options/{optionName} Delete an option from an asset dropdown field · Delete Asset Dropdown Field Option #
Ask an LLM
“Can I remove one choice from an asset dropdown field?”
“How do I delete a single asset dropdown option by name?”
Tell an agent destructive · confirm first
Delete option {optionName} from asset dropdown field {fieldID}.
Remove choice {optionName} on asset field {fieldID}.
POST /v2/assets/fields/batch/update Update many asset field values at once · Batch Update Asset Fields #
Ask an LLM
“Can I update several asset field values in one call?”
“What is the minimum number of field values a batch asset update needs?”
Tell an agent
Batch update a set of asset field values in a single request.
Push these meter readings to multiple asset fields at once.
GET /v2/assets/parts List which parts are linked to which assets · Asset Parts #
Ask an LLM
“Which spare parts are associated with each asset, and in what quantity?”
“Can I see all part-to-asset relationships for a set of parts?”
Tell an agent
List part-asset relations for assets {assets}.
Show which assets use parts {parts}.
GET /v2/assets List assets · Assets #
Ask an LLM
“What equipment and assets do I have in my CMMS?”
“Can I list only the child assets under a particular parent asset?”
Tell an agent
List assets at locations {locations}.
Find assets named {name}.
POST /v2/assets Create a new asset · New Asset #
Ask an LLM
“How do I add a new piece of equipment to the system?”
“Can I set weekly operating hours when creating an asset?”
Tell an agent
Create a new blank asset.
Add a new equipment record called Boiler 3.
DELETE /v2/assets/{assetID} Delete an asset · Delete Asset #
Ask an LLM
“Can I permanently remove an asset from my account?”
“What happens when I delete an asset record?”
Tell an agent destructive · confirm first
Delete asset {assetID}.
Remove equipment record {assetID} from the account.
PATCH /v2/assets/{assetID} Update an asset's top-level details · Patch Asset #
Ask an LLM
“How do I rename an asset or change its top-level information?”
“Can I change an asset's parent or hours per week?”
Tell an agent
Rename asset {assetID}.
Update the top-level details of asset {assetID}.
PATCH /v2/assets/{assetID}/move Move an asset to another location · Move Asset to another Location #
Ask an LLM
“Can I transfer an asset from one site to another?”
“Can a parent asset with children be moved to a different location?”
Tell an agent
Move asset {assetID} to location {locationID}.
Transfer asset {assetID} to location {locationID} and bring its parts with it ({transferParts}).
POST /v2/locations Create a new location · New Location #
Ask an LLM
“How do I add a new site or facility?”
“Does a new location need a timezone?”
Tell an agent
Create a new location.
Add a facility called North Plant with its timezone.
GET /v2/locations List locations · Locations #
Ask an LLM
“What sites or locations are set up in my account?”
“Can I list the locations that belong to a particular region?”
Tell an agent
List my locations.
Show locations in regions {regions}.
PATCH /v2/locations/{locationID} Update a location's name or timezone · Update Location #
Ask an LLM
“Can I rename a location or change its timezone?”
“How do I edit a site's details?”
Tell an agent
Rename location {locationID}.
Change the timezone of location {locationID}.
DELETE /v2/locations/{locationID} Delete a location and everything in it · Delete Location #
Ask an LLM
“What happens to assets, parts and tasks when a location is removed?”
“Can I delete an entire site from my account?”
Tell an agent destructive · confirm first
Delete location {locationID} and all its contents.
Remove site {locationID} from the account.
PUT /v2/parts/{partID}/image Set the main image for a part · Add Part Image #
Ask an LLM
“Can I add a photo to a spare part record?”
“How do I set a part's main picture?”
Tell an agent
Upload the main image for part {partID}.
Set a photo on inventory part {partID}.
DELETE /v2/parts/{partID}/image Remove a part's main image · Delete Part Image #
Ask an LLM
“How do I remove the photo from a part?”
“Can a part's main picture be cleared?”
Tell an agent destructive · confirm first
Delete the main image on part {partID}.
Remove the photo from inventory part {partID}.
POST /v2/parts/categories Create a part category · Create Part Category #
Ask an LLM
“How do I create a new category to organize parts?”
“Can I add a Filters category for inventory?”
Tell an agent
Create a new part category.
Add a part category called Belts.
GET /v2/parts/categories List part categories · Get Categories #
Ask an LLM
“What categories are my parts organized into?”
“Is there a part category called Filters?”
Tell an agent
List all part categories.
Find the part category named {name}.
PATCH /v2/parts/categories/{categoryID} Rename a part category · Update Part Category #
Ask an LLM
“Can I rename a part category?”
“How do I change what a parts category is called?”
Tell an agent
Rename part category {categoryID}.
Change the name of parts category {categoryID}.
DELETE /v2/parts/categories/{categoryID} Delete a part category · Delete Part Category #
Ask an LLM
“What happens to parts when their category is deleted?”
“Can I remove a part category I no longer use?”
Tell an agent destructive · confirm first
Delete part category {categoryID}.
Remove part category {categoryID} from every part.
GET /v2/parts/fields List custom field values on parts · Part Fields #
Ask an LLM
“What custom field values are set on my parts?”
“Can I pull files attached to part fields?”
Tell an agent
Show the field values for parts {parts}.
List part field values named {name} at locations {locations}.
POST /v2/parts/fields Create a new suggested field for parts · New Part Suggested Field #
Ask an LLM
“Can I define a new custom field that parts at a location can use?”
“How do I add a suggested field for inventory parts?”
Tell an agent
Create a new suggested part field for a location.
Add a custom field to the suggested fields for parts.
GET /v2/parts/fields/suggested List suggested fields available to parts · Part Suggested Fields #
Ask an LLM
“Which fields can a part pick from when deciding its fields?”
“What suggested part fields exist?”
Tell an agent
List the suggested part fields.
Show the suggested part field named {name}.
PATCH /v2/parts/fields/{valueID} Update the value of a part's field · Update Part Field Value #
Ask an LLM
“How do I change a value stored in a part's custom field?”
“Does the value format for a part field depend on its field type?”
Tell an agent
Update part field value {valueID}.
Set a new value for the part field {valueID}.
DELETE /v2/parts/fields/{valueID} Remove a field from a part · Delete Part Field #
Ask an LLM
“Can I detach a custom field from a part?”
“How do I delete a field value attached to an inventory item?”
Tell an agent destructive · confirm first
Delete part field value {valueID}.
Remove the attached part field {valueID}.
PUT /v2/parts/{partID}/fields Attach a suggested field to a part · Attach Field to Part #
Ask an LLM
“How do I add a suggested field to one of my parts?”
“Can I give an inventory part a custom field it doesn't have yet?”
Tell an agent
Attach a suggested field to part {partID}.
Add an existing custom field to inventory part {partID}.
GET /v2/parts/{partID}/logs List log entries for one part · Part Logs #
Ask an LLM
“What is the log history for one specific part?”
“Can I filter a part's logs by source or by the user who made them?”
Tell an agent
Show the logs for part {partID}.
List part {partID} log entries from sources {sources}.
POST /v2/parts/{partID}/logs Add a manual log entry to a part · New Part Log #
Ask an LLM
“How do I write a manual note into a part's log?”
“Can a part log entry be attributed to a specific user?”
Tell an agent
Add the log entry {logEntry} to part {partID}.
Log {logEntry} on part {partID} as user {userID}.
PATCH /v2/parts/logs/{logID} Edit a manual part log entry · Update Part Log #
Ask an LLM
“Can I edit the text of a manual part log?”
“Are only manual part logs editable?”
Tell an agent
Change the text of part log {logID} to {logEntry}.
Update manual part log entry {logID}.
DELETE /v2/parts/logs/{logID} Delete a manual part log entry · Delete Part Log #
Ask an LLM
“Which part logs can be deleted through the API?”
“Can I remove a manual note from a part's history?”
Tell an agent destructive · confirm first
Delete part log {logID}.
Remove manual part log entry {logID}.
GET /v2/parts/logs List part logs across the whole account · All Part Logs #
Ask an LLM
“Can I see part logs for every part in my account at once?”
“Which part log entries were written by a certain user across all inventory?”
Tell an agent
List all part logs across the account.
Show account-wide part logs for parts {parts} since {start}.
GET /v2/parts/{partID}/purchasables Get a part's purchasable units · Get Purchasables #
Ask an LLM
“What purchasable options are defined for a part?”
“Can I look up a part's purchasables by name prefix?”
Tell an agent
Show the purchasables for part {partID}.
List purchasables of part {partID} starting with {nameStartsWith}.
GET /v2/parts/vendors/associations List vendor-part associations · Get Part Vendor Associations #
Ask an LLM
“Which vendors supply which parts?”
“Can I find a part association by the vendor's part number?”
Tell an agent
List vendor associations for parts {parts}.
Find vendor-part associations with vendor part number {vendorPartNumber}.
POST /v2/parts/vendors/associations Link a vendor to a part · Create Part Vendor Association #
Ask an LLM
“How do I record that a vendor supplies a certain part?”
“Does the vendor need to be available at the part's location to link them?”
Tell an agent
Associate vendor {vendorID} with part {partID}.
Link part {partID} to supplier {vendorID}.
DELETE /v2/parts/vendors/associations/{relationID} Remove a vendor-part association · Delete Part Vendor Association #
Ask an LLM
“Can I unlink a vendor from a part?”
“Which vendor-part associations can be deleted?”
Tell an agent destructive · confirm first
Delete vendor-part association {relationID}.
Remove the manual vendor link {relationID}.
GET /v2/parts List parts in inventory · Parts #
Ask an LLM
“What spare parts do I have in inventory?”
“Can I look up parts by their part number?”
Tell an agent
List parts at locations {locations}.
Find parts named {name}.
POST /v2/parts Add a new part to inventory · Create Part #
Ask an LLM
“How do I add a new spare part to my inventory list?”
“Do new parts need a location?”
Tell an agent
Create a new inventory part.
Add a new spare part to inventory at my main location.
GET /v2/parts/fields/{fieldID}/options List options of a part dropdown field · Get Part Dropdown Field Options #
Ask an LLM
“What choices are available in a part dropdown field?”
“Which options can I pick for a part's dropdown custom field?”
Tell an agent
Show the options for part dropdown field {fieldID}.
List choices of part field {fieldID}.
POST /v2/parts/fields/{fieldID}/options Append options to a part dropdown field · Append Part Dropdown Field Option(s) #
Ask an LLM
“Can inventory part dropdowns get extra options while keeping the current list?”
“What happens if I append a duplicate option to a part field?”
Tell an agent
Append options to part dropdown field {fieldID}.
Add new choices to part field {fieldID}, keeping the existing ones.
PUT /v2/parts/fields/{fieldID}/options Replace all options of a part dropdown field · Replace Part Dropdown Field Options #
Ask an LLM
“Can I overwrite the entire option list of a part dropdown field?”
“What happens to existing part dropdown options when I replace them?”
Tell an agent destructive · confirm first
Replace the options of part dropdown field {fieldID} with {options}.
Overwrite part field {fieldID} choices with {options}.
DELETE /v2/parts/fields/{fieldID}/options/{optionName} Delete an option from a part dropdown field · Delete Part Dropdown Field Option #
Ask an LLM
“Can I remove one choice from a part dropdown field?”
“How do I delete a single part dropdown option by name?”
Tell an agent destructive · confirm first
Delete option {optionName} from part dropdown field {fieldID}.
Remove choice {optionName} on part field {fieldID}.
PATCH /v2/parts/{partID} Update a part's details or quantity · Update Part #
Ask an LLM
“How do I adjust a part's quantity on hand?”
“Can I change a part's name or price?”
Tell an agent
Update the quantity of part {partID}.
Edit the details of inventory part {partID}.
DELETE /v2/parts/{partID} Delete a part from inventory · Delete Part #
Ask an LLM
“Can I remove a part from the inventory list?”
“How do I delete a discontinued part record?”
Tell an agent destructive · confirm first
Delete part {partID}.
Remove inventory part {partID}.
GET /v2/parts/usage Get the parts usage log · Parts Usage #
Ask an LLM
“Which parts were used on which tasks?”
“Can I see parts consumption within a date range?”
Tell an agent
Show the parts usage log for parts {parts}.
List parts used on tasks {tasks}.
PUT /v2/tasks/{taskID}/invoices/{invoiceID}/file Attach a file to a task invoice · Attach a file to an invoice #
Ask an LLM
“Can I attach a scanned invoice image to a task's invoice?”
“Does the task need to be open to add an invoice file?”
Tell an agent
Attach a file to invoice {invoiceID} on task {taskID}.
Upload the receipt image to task {taskID} invoice {invoiceID}.
DELETE /v2/tasks/{taskID}/invoices/{invoiceID}/file Remove a file from a task invoice · Delete file from Invoice #
Ask an LLM
“How do I remove an attachment from a task invoice?”
“Can files be deleted from invoices on completed tasks?”
Tell an agent destructive · confirm first
Delete the file on invoice {invoiceID} of task {taskID}.
Remove the attached receipt from task {taskID} invoice {invoiceID}.
GET /v2/tasks/invoices List invoices on tasks · Invoices #
Ask an LLM
“What invoices have been recorded against work orders?”
“Can I pull task invoices within a date range?”
Tell an agent
List invoices on tasks {tasks}.
Show task invoices {invoices}.
PUT /v2/tasks/{taskID}/invoices Add an invoice to a task · Attach an Invoice to task #
Ask an LLM
“How do I record an outside invoice cost on a work order?”
“Can I add a description along with the invoice cost?”
Tell an agent
Add an invoice for {cost} to task {taskID}.
Attach an invoice costing {cost} described as {description} to task {taskID}.
DELETE /v2/tasks/{taskID}/invoices/{invoiceID} Remove an invoice from a task · Delete invoice from task #
Ask an LLM
“Can I remove an invoice from an open work order?”
“How do I delete a wrong invoice from a task?”
Tell an agent destructive · confirm first
Delete invoice {invoiceID} from task {taskID}.
Remove invoice {invoiceID} on task {taskID}.
PATCH /v2/tasks/{taskID}/invoices/{invoiceID} Update an invoice on a task · Update an Invoice #
Ask an LLM
“Can I change the cost of an invoice already on a task?”
“How do I correct an invoice description on an open task?”
Tell an agent
Change invoice {invoiceID} on task {taskID} to cost {cost}.
Update the description of task {taskID} invoice {invoiceID} to {description}.
GET /v2/tasks/{taskID}/instructions/{instructionID}/options List options of a dropdown or option instruction · Instruction Options #
Ask an LLM
“What choices are available in a task instruction's dropdown?”
“Can I see the options on an option-list checklist item?”
Tell an agent
List the options for instruction {instructionID} on task {taskID}.
Show dropdown choices of task {taskID} instruction {instructionID}.
POST /v2/tasks/{taskID}/instructions/{instructionID}/options Add an option to a task instruction · New Instruction Option #
Ask an LLM
“How do I add a new choice to a dropdown checklist item on a task?”
“Can I control the order of a new instruction option?”
Tell an agent
Add option {instruction} to instruction {instructionID} on task {taskID}.
Create option {instruction} at position {instructionOptionOrder} for task {taskID} instruction {instructionID}.
DELETE /v2/tasks/instructions/{instructionID}/options/{instructionOptionID} Delete an option from a task instruction · Delete Instruction Option #
Ask an LLM
“Can I remove a choice from a dropdown instruction?”
“How do I delete an option from an option-list checklist item?”
Tell an agent destructive · confirm first
Delete option {instructionOptionID} from instruction {instructionID}.
Remove choice {instructionOptionID} on checklist item {instructionID}.
PATCH /v2/tasks/instructions/{instructionID}/options/{instructionOptionID} Edit an option on a task instruction · Update Instruction Option #
Ask an LLM
“Can I rename or reorder an existing dropdown option on an instruction?”
“How do I change the text of an option-list choice?”
Tell an agent
Rename option {instructionOptionID} on instruction {instructionID} to {instruction}.
Move option {instructionOptionID} of instruction {instructionID} to position {instructionOptionOrder}.
GET /v2/tasks/{taskID}/instructions List a task's instructions · Task Instructions #
Ask an LLM
“What checklist steps are on a given work order?”
“Can I page through a long task checklist?”
Tell an agent
List the instructions on task {taskID}.
Show the checklist for task {taskID}.
POST /v2/tasks/{taskID}/instructions Add an instruction to a task · New Task Instruction #
Ask an LLM
“Can I add a checkbox or signature step to a task's checklist?”
“Which checklist item types can a new task instruction be?”
Tell an agent
Add a new instruction to task {taskID}.
Create a text-box checklist step on task {taskID}.
PATCH /v2/tasks/instructions/{instructionID} Update a task instruction · Update Task Instruction #
Ask an LLM
“Can I change the text of an existing checklist step?”
“How do I edit a task instruction?”
Tell an agent
Update task instruction {instructionID}.
Reword checklist step {instructionID}.
DELETE /v2/tasks/instructions/{instructionID} Delete a task instruction · Delete Task Instruction #
Ask an LLM
“How do I remove a step from a task checklist?”
“Can a task instruction be deleted?”
Tell an agent destructive · confirm first
Delete task instruction {instructionID}.
Remove checklist step {instructionID} from its task.
GET /v2/tasks/instructions/{instructionID} Get a single task instruction · Get Task Instruction by ID #
Ask an LLM
“Can I look up one checklist item by its instruction ID?”
“What are the details of a specific task instruction?”
Tell an agent
Get task instruction {instructionID}.
Show the details of checklist item {instructionID}.
GET /v2/tasks/instructions Get instructions across multiple tasks · Batch Task Instructions #
Ask an LLM
“Can I fetch checklist instructions for many tasks at once?”
“Which instructions belong to several work orders together?”
Tell an agent
Get the instructions for tasks {tasks}.
Batch fetch checklists across tasks {tasks}.
PUT /v2/tasks/instructions/{instructionID}/image Add an image to a task instruction · Task Instruction Image #
Ask an LLM
“Can I add an instructional picture to a checklist step?”
“What filename is returned when I upload an image to an instruction?”
Tell an agent
Upload an image to instruction {instructionID}.
Add an instructional photo to checklist step {instructionID}.
DELETE /v2/tasks/instructions/{instructionID}/image Remove an image from a task instruction · Delete Task Instruction Image #
Ask an LLM
“How do I delete a picture from a checklist step?”
“Can I remove one specific image file from an instruction?”
Tell an agent destructive · confirm first
Remove image {filename} from instruction {instructionID}.
Delete the instructional image on checklist step {instructionID}.
PUT /v2/tasks/{taskID}/image Upload a task's main image · Upload Task Main Image #
Ask an LLM
“Can I set a main image on a work order?”
“How do I attach a primary photo to a task?”
Tell an agent
Upload the main image for task {taskID}.
Set a photo as the main picture of work order {taskID}.
DELETE /v2/tasks/{taskID}/image Delete a task's main image · Delete Task Main Image #
Ask an LLM
“How do I remove the main picture from a task?”
“Can a work order's primary photo be deleted?”
Tell an agent destructive · confirm first
Delete the main image of task {taskID}.
Clear the primary photo on work order {taskID}.
GET /v2/tasks/labor List labor time logged on tasks · Task Labor #
Ask an LLM
“How much time did technicians spend on each work order?”
“Can I see labor hours logged by a specific user?”
Tell an agent
Show labor logged on tasks {tasks}.
List time entries by users {users} between {start} and {end}.
GET /v2/tasks/labor/categories List labor categories · Get Labor Categories #
Ask an LLM
“What billing categories exist for labor time?”
“Is there a labor category called Overtime?”
Tell an agent
List all labor categories.
Find the labor category named {name}.
GET /v2/tasks/{taskID}/parts List parts attached to a task · Get attached parts #
Ask an LLM
“What parts are being used on this work order?”
“Which parts are associated with a given task?”
Tell an agent
Show the parts attached to task {taskID}.
List parts on work order {taskID}.
PUT /v2/tasks/{taskID}/parts Attach a part to a task · Attach part to task #
Ask an LLM
“How do I add a part to a work order?”
“Can I associate a spare part with a task?”
Tell an agent
Attach a part to task {taskID}.
Add a spare part to work order {taskID}.
GET /v2/tasks/parts List parts attached across all tasks · Get all attached parts #
Ask an LLM
“Which parts are attached to tasks across the whole account?”
“Which work orders use a particular part?”
Tell an agent
List parts attached to any task.
Show task-part attachments for parts {parts}.
DELETE /v2/tasks/{taskID}/{partID} Remove a part from a task · Delete part from task #
Ask an LLM
“Can I take a part off a work order?”
“How do I detach a part from a task?”
Tell an agent destructive · confirm first
Remove part {partID} from task {taskID}.
Delete the part {partID} attached to work order {taskID}.
GET /v2/tasks/{taskID}/comments List a task's comments · Task Comments #
Ask an LLM
“What comments have been left on a work order?”
“Can I read the discussion on a task?”
Tell an agent
Show the comments on task {taskID}.
List comments for work order {taskID}.
POST /v2/tasks/{taskID}/comments Add a comment to a task · Add Task Comments #
Ask an LLM
“How do I post a comment on a work order?”
“Can a task comment be shown to external users?”
Tell an agent
Comment {comment} on task {taskID}.
Add comment {comment} to task {taskID} and show it to external users ({showExternalUsers}).
GET /v2/tasks/{taskID}/tags List custom tags on a task · Tags #
Ask an LLM
“Which custom tags are applied to a work order?”
“What tags does this task have?”
Tell an agent
Show the tags on task {taskID}.
List custom tags applied to work order {taskID}.
PUT /v2/tasks/{taskID}/tags Apply existing tags to a task · PUT Apply Task Tags #
Ask an LLM
“How do I tag a work order with existing custom tags?”
“Do tags need to exist at the account level before applying them to a task?”
Tell an agent
Apply tags to task {taskID}.
Tag work order {taskID} with the existing Safety tag.
DELETE /v2/tasks/{taskID}/tags/{tagRaw} Remove a tag from a task · DELETE Remove Task Tag #
Ask an LLM
“Can I remove a single tag from a work order?”
“How do I untag a task?”
Tell an agent destructive · confirm first
Remove tag {tagRaw} from task {taskID}.
Untag work order {taskID} from {tagRaw}.
GET /v2/work-requests/work-request-submissions List work request submissions · List WR Submissions #
Ask an LLM
“What work requests have been submitted and are waiting for review?”
“Can I filter work request submissions by status or creation date?”
Tell an agent
List work request submissions with statuses {statuses}.
Show work request submissions at locations {locationIDs}.
POST /v2/work-requests/work-request-submissions Submit a new work request · Create WR Submission #
Ask an LLM
“How do I submit a maintenance request that a reviewer must approve?”
“What is required to create a work request submission?”
Tell an agent
Submit a work request at location {locationID} due in {dueDateUnit}.
Create a work request titled {requestTitle} at location {locationID} with due unit {dueDateUnit}.
POST /v2/work-requests/work-request-submissions/{workRequestSubmissionID}/approve Approve a work request submission · Approve WR Submission #
Ask an LLM
“How do I approve a pending work request so it becomes a task?”
“Does approving a submission generate a work order?”
Tell an agent
Approve work request submission {workRequestSubmissionID}.
Accept pending request {workRequestSubmissionID} and turn it into a task.
POST /v2/work-requests/work-request-submissions/{workRequestSubmissionID}/decline Decline a work request submission · Decline WR Submission #
Ask an LLM
“Can I reject a pending work request with a reason?”
“What notes can I include when declining a request?”
Tell an agent destructive · confirm first
Decline work request submission {workRequestSubmissionID}.
Reject request {workRequestSubmissionID} because {declineReason}.
POST /v2/tasks Create a new task or work order · New Task #
Ask an LLM
“How do I create a work order and assign it?”
“What task types can I create, such as PM or unplanned WO?”
Tell an agent
Create a task named {name} at location {locationID} due {due}.
Create a work order of type {type} called {name} at location {locationID}.
GET /v2/tasks List tasks and work orders · Tasks #
Ask an LLM
“What open work orders do I have?”
“Can I find preventive maintenance tasks scheduled for next week?”
Tell an agent
List tasks at locations {locations}.
Show tasks assigned to users {users}.
PATCH /v2/tasks/{taskID} Update a task's details · Update Task #
Ask an LLM
“How do I reassign a work order or change its due date?”
“Can I change a task's name or location?”
Tell an agent
Update task {taskID}.
Change the due date of work order {taskID}.
DELETE /v2/tasks/{taskID} Delete a task · Delete Task #
Ask an LLM
“Can I delete a work order entirely?”
“How do I remove a task created by mistake?”
Tell an agent destructive · confirm first
Delete task {taskID}.
Remove work order {taskID}.
GET /v2/users/{userID}/roles List a user's roles by location · Get User Roles #
Ask an LLM
“Which roles does a user have and at which locations?”
“Is a given user an admin at a certain site?”
Tell an agent
Show the roles for user {userID}.
List user {userID} roles at locations {locations}.
PUT /v2/users/{userID}/roles Add a user to a role · Add User To Role #
Ask an LLM
“How do I give a user a role?”
“Can I assign a role to someone at a location?”
Tell an agent
Add user {userID} to a role.
Grant a role to user {userID}.
DELETE /v2/users/{userID}/roles Remove a role from a user · Remove Role From User #
Ask an LLM
“How do I take a role away from a user?”
“Can I revoke someone's role at a location?”
Tell an agent destructive · confirm first
Remove a role from user {userID}.
Revoke the role held by user {userID}.
GET /v2/users/{userID}/teams List a user's teams by location · Get User Teams #
Ask an LLM
“Which teams is a user on and at which locations?”
“What teams does this technician belong to?”
Tell an agent
Show the teams for user {userID}.
List user {userID} teams at locations {locations}.
PUT /v2/users/{userID}/teams Add a user to a team · Add User To Team #
Ask an LLM
“How do I put a user on a team?”
“Can I add a technician to a maintenance crew?”
Tell an agent
Add user {userID} to a team.
Put user {userID} on the night shift team.
DELETE /v2/users/{userID}/teams Remove a user from a team · Remove Team From User #
Ask an LLM
“How do I take a user off a team?”
“Can I remove someone from a crew?”
Tell an agent destructive · confirm first
Remove user {userID} from a team.
Take user {userID} off their team.
GET /v2/users/capacity/exceptions/{userID} Get capacity exceptions for one user · Get Capacity Exceptions by User #
Ask an LLM
“What days off or reduced capacity does a specific user have?”
“Can I see one technician's capacity exceptions in a date range?”
Tell an agent
Show capacity exceptions for user {userID}.
List user {userID} capacity exceptions from {startDate} to {endDate}.
POST /v2/users/capacity/exceptions/{userID} Create a capacity exception for a user · New Capacity Exception #
Ask an LLM
“How do I record that a technician is only available half days next week?”
“Is capacity in an exception measured per day?”
Tell an agent
Create a capacity exception for user {userID} from {exceptionStartDate} to {exceptionEndDate}.
Set user {userID} to {capacityMinutes} minutes per day from {exceptionStartDate} to {exceptionEndDate}.
GET /v2/users/capacity/exceptions List capacity exceptions by location · Get Capacity Exceptions by Location #
Ask an LLM
“Which users have capacity exceptions at my locations?”
“Who is on reduced availability across a site this month?”
Tell an agent
List capacity exceptions at locations {locations}.
Show capacity exceptions for users {users} between {startDate} and {endDate}.
DELETE /v2/users/capacity/exceptions/{userID}/{exceptionID} Delete a user's capacity exception · Delete Capacity Exception #
Ask an LLM
“Can I cancel a capacity exception I entered for a user?”
“How do I remove a day-off record?”
Tell an agent destructive · confirm first
Delete capacity exception {exceptionID} for user {userID}.
Remove user {userID}'s availability exception {exceptionID}.
PATCH /v2/users/capacity/exceptions/{userID}/{exceptionID} Update a user's capacity exception · Update Capacity Exception #
Ask an LLM
“Can I change the dates or minutes of an existing capacity exception?”
“How do I edit a technician's availability exception?”
Tell an agent
Change exception {exceptionID} for user {userID} to {capacityMinutes} minutes per day.
Update user {userID} exception {exceptionID} to end on {exceptionEndDate}.
GET /v2/users/capacity/schedules Get daily capacity for users · Get Capacity Schedules #
Ask an LLM
“How many minutes of capacity does each user have per day in a date range?”
“Which rule wins when a holiday and a user schedule overlap?”
Tell an agent
Show daily capacity for users {users} from {startDate} to {endDate}.
List capacity schedules at locations {locations}.
POST /v2/users/capacity/schedules Create a capacity schedule · Create Capacity Schedule #
Ask an LLM
“How do I set a recurring weekly work schedule for a technician?”
“Can a capacity schedule rotate weeks on and weeks off?”
Tell an agent
Create capacity schedule {scheduleName} starting {startDate} at location {locationID} for user {userID}.
Create schedule {scheduleName} for team profile {profileID} at location {locationID} from {startDate} to {endDate}.
DELETE /v2/users/capacity/schedules/{scheduleID} Delete a capacity schedule · Delete Capacity Schedule #
Ask an LLM
“Can I remove a capacity schedule I no longer need?”
“How do I delete a technician's work schedule?”
Tell an agent destructive · confirm first
Delete capacity schedule {scheduleID}.
Remove work schedule {scheduleID}.
GET /v2/users List users · Users #
Ask an LLM
“Who are the users on my account and what are their emails?”
“Can I list users that hold a particular role or team?”
Tell an agent
List all users.
Find users named {name}.
POST /v2/users Create a new user · New User #
Ask an LLM
“How do I add a new person to the account?”
“Does a new user get a welcome email?”
Tell an agent
Create a new user and send them a welcome email.
Invite a new technician to the account.
PATCH /v2/users/{userID} Update a user's details · Update User #
Ask an LLM
“How do I change a user's name, phone number or active status?”
“Can I deactivate a user without deleting them?”
Tell an agent
Update user {userID}.
Mark user {userID} as inactive.
DELETE /v2/users/{userID} Delete a user · Delete User #
Ask an LLM
“Can I remove a user from my account?”
“How do I delete someone who left the company?”
Tell an agent destructive · confirm first
Delete user {userID}.
Remove user {userID} from the account.
GET /v2/vendors/fields List custom field values on vendors · Vendor Fields #
Ask an LLM
“What contact details and contracts are stored in vendor fields?”
“Can I filter vendor field values by field name?”
Tell an agent
Show the field values for vendors {vendors}.
List vendor field values named {name}.
POST /v2/vendors/fields Create a new suggested field for vendors · New Vendor Suggested Field #
Ask an LLM
“Can I define a new custom field that vendors at a location can use?”
“How do I add a suggested vendor field like Contract Expiry?”
Tell an agent
Create a new suggested vendor field for a location.
Add a custom field to the suggested fields for vendors.
GET /v2/vendors/fields/suggested List suggested fields available to vendors · Vendor Suggested Fields #
Ask an LLM
“Which fields can a vendor pick from when deciding its fields?”
“What suggested vendor fields exist?”
Tell an agent
List the suggested vendor fields.
Show the suggested vendor field named {name}.
PATCH /v2/vendors/fields/{valueID} Update the value of a vendor's field · Update Vendor Field Value #
Ask an LLM
“How do I change a value stored in a vendor's custom field?”
“Can I update a supplier's contract date field?”
Tell an agent
Update vendor field value {valueID}.
Set a new value for the vendor field {valueID}.
DELETE /v2/vendors/fields/{valueID} Remove a field from a vendor · Delete Vendor Field #
Ask an LLM
“Can I detach a custom field from a vendor?”
“How do I delete a vendor's field value?”
Tell an agent destructive · confirm first
Delete vendor field value {valueID}.
Remove the attached vendor field {valueID}.
GET /v2/vendors/fields/{fieldID}/options List options of a vendor dropdown field · Get Vendor Dropdown Field Options #
Ask an LLM
“What choices are available in a vendor dropdown field?”
“Which options can I pick for a vendor's dropdown custom field?”
Tell an agent
Show the options for vendor dropdown field {fieldID}.
List choices of vendor field {fieldID}.
POST /v2/vendors/fields/{fieldID}/options Append options to a vendor dropdown field · Append Vendor Dropdown Field Option(s) #
Ask an LLM
“Is it possible to extend a supplier dropdown field with more options?”
“What happens if I append a duplicate option to a vendor field?”
Tell an agent
Append options to vendor dropdown field {fieldID}.
Add new choices to vendor field {fieldID}, keeping the existing ones.
PUT /v2/vendors/fields/{fieldID}/options Replace all options of a vendor dropdown field · Replace Vendor Dropdown Field Options #
Ask an LLM
“Can I overwrite the entire option list of a vendor dropdown field?”
“What happens to existing vendor dropdown options when I replace them?”
Tell an agent destructive · confirm first
Replace the options of vendor dropdown field {fieldID} with {options}.
Overwrite vendor field {fieldID} choices with {options}.
DELETE /v2/vendors/fields/{fieldID}/options/{optionName} Delete an option from a vendor dropdown field · Delete Vendor Dropdown Field Option #
Ask an LLM
“Can I remove one choice from a vendor dropdown field?”
“How do I delete a single vendor dropdown option by name?”
Tell an agent destructive · confirm first
Delete option {optionName} from vendor dropdown field {fieldID}.
Remove choice {optionName} on vendor field {fieldID}.
PUT /v2/vendors/{vendorID}/fields Attach a suggested field to a vendor · Attach Field to Vendor #
Ask an LLM
“How do I add a suggested field to a vendor?”
“Can I give a supplier a custom field it doesn't have yet?”
Tell an agent
Attach a suggested field to vendor {vendorID}.
Add an existing custom field to supplier {vendorID}.
PUT /v2/vendors/{vendorID}/image Set the main image for a vendor · Add Vendor Image #
Ask an LLM
“Can I add a logo or photo to a vendor?”
“How do I set a vendor's main image?”
Tell an agent
Upload the main image for vendor {vendorID}.
Set a logo on supplier {vendorID}.
DELETE /v2/vendors/{vendorID}/image Remove a vendor's main image · Delete Vendor Image #
Ask an LLM
“How do I remove a vendor's picture?”
“Can a supplier's logo be cleared?”
Tell an agent destructive · confirm first
Delete the main image on vendor {vendorID}.
Remove the logo from supplier {vendorID}.
DELETE /v2/vendors/logs/file/{fileID} Delete a file attached to a vendor log · Delete Vendor Log File #
Ask an LLM
“Can I remove an attachment from a vendor log entry?”
“How do I delete a file uploaded to a supplier log?”
Tell an agent destructive · confirm first
Delete vendor log file {fileID}.
Remove attachment {fileID} from its vendor log.
PUT /v2/vendors/{vendorID}/logs/{logID}/file Attach a file to a vendor log · Add Vendor Log File #
Ask an LLM
“Can I attach a document to a vendor log entry?”
“How do I add a file to a supplier's log?”
Tell an agent
Attach a file to log {logID} on vendor {vendorID}.
Upload a document to vendor {vendorID}'s log entry {logID}.
GET /v2/vendors/{vendorID}/logs List manual log entries for a vendor · Vendor Logs #
Ask an LLM
“What notes have been logged against a supplier?”
“Can I search a vendor's log entries by text?”
Tell an agent
Show the logs for vendor {vendorID}.
List vendor {vendorID} log entries containing {logEntry}.
POST /v2/vendors/{vendorID}/logs Add a manual log entry to a vendor · New Vendor Log #
Ask an LLM
“How do I write a note into a vendor's log?”
“Does a vendor log entry need a user ID?”
Tell an agent
Log {logEntry} on vendor {vendorID} as user {userID}.
Add a supplier note {logEntry} to vendor {vendorID} from user {userID}.
PATCH /v2/vendors/logs/{logID} Edit a manual vendor log entry · Update Vendor Log #
Ask an LLM
“Can I correct the text of a vendor log entry?”
“How do I edit a supplier note?”
Tell an agent
Change the text of vendor log {logID} to {logEntry}.
Update manual vendor log entry {logID}.
DELETE /v2/vendors/logs/{logID} Delete a manual vendor log entry · Delete Vendor Log #
Ask an LLM
“Can I delete a note I made on a vendor?”
“How do I remove a vendor log entry?”
Tell an agent destructive · confirm first
Delete vendor log {logID}.
Remove manual vendor log entry {logID}.
GET /v2/vendors List vendors · Vendors #
Ask an LLM
“Which vendors and suppliers are in my account?”
“Can I list vendors at a particular location?”
Tell an agent
List vendors at locations {locations}.
Find vendors named {name}.
POST /v2/vendors Create a new vendor · New Vendor #
Ask an LLM
“How do I add a new supplier?”
“Which location does a new vendor belong to?”
Tell an agent
Create a new vendor.
Add a supplier called Acme Hydraulics.
PATCH /v2/vendors/{vendorID} Update a vendor's contact details · Update Vendor #
Ask an LLM
“How do I change a vendor's phone, email or address?”
“Can I update a supplier's contact person?”
Tell an agent
Update vendor {vendorID}.
Change the email address of supplier {vendorID}.
DELETE /v2/vendors/{vendorID} Delete a vendor · Delete Vendor #
Ask an LLM
“Can I delete a vendor I no longer buy from?”
“How do I remove a supplier record?”
Tell an agent destructive · confirm first
Delete vendor {vendorID}.
Remove supplier {vendorID}.
GET /v2/roles List roles · Get Roles #
Ask an LLM
“What access roles are defined in my account?”
“Is there a role called Technician?”
Tell an agent
List all roles.
Find the role named {name}.
POST /v2/roles Create a role · Create Role #
Ask an LLM
“How do I create a new access role?”
“Can I set a role's permissions when creating it through the API?”
Tell an agent
Create a new role.
Add a role called Contractor.
PATCH /v2/roles/{roleID} Rename a role · Update Role #
Ask an LLM
“Can I rename an access role?”
“How do I change what a role is called?”
Tell an agent
Rename role {roleID}.
Change the name of access role {roleID}.
DELETE /v2/roles/{roleID} Delete a role · Delete Role #
Ask an LLM
“What happens to users when their role is deleted?”
“Can I remove an access role?”
Tell an agent destructive · confirm first
Delete role {roleID}.
Remove role {roleID} from the account and all users.
GET /v2/teams List teams · Get Teams #
Ask an LLM
“What teams exist in my account?”
“Can I include each team's roles or skip auto-created teams?”
Tell an agent
List all teams.
Find the team named {name}.
POST /v2/teams Create a team · Create Team #
Ask an LLM
“How do I create a new maintenance team?”
“Does a team belong to a location?”
Tell an agent
Create a new team.
Add a team called Electrical Crew.
PATCH /v2/teams/{teamID} Rename a team · Update Team #
Ask an LLM
“Can I rename a team?”
“How do I change a crew's name?”
Tell an agent
Rename team {teamID}.
Change the name of crew {teamID}.
DELETE /v2/teams/{teamID} Delete a team · Delete Team #
Ask an LLM
“What happens to users when their team is deleted?”
“Can I remove a team?”
Tell an agent destructive · confirm first
Delete team {teamID}.
Remove team {teamID} and unassign its users.
GET /v2/po/items List purchase order line items · Get Purchase Order Items #
Ask an LLM
“What line items are on my purchase orders?”
“Can I find PO items edited within a date range?”
Tell an agent
List items on purchase orders {pos}.
Show PO line items {items}.
POST /v2/po/{poID}/items Add a line item to a purchase order · New Purchase Order Item #
Ask an LLM
“How do I add a part or service line to a purchase order?”
“Can I set tax, discount and shipping on a PO line?”
Tell an agent
Add part {partID} to purchase order {poID} with quantity {quantity}.
Add a line of type {itemType} at rate {rate} to PO {poID}.
PATCH /v2/po/{poID}/items/{poItemID} Update a purchase order line item · Update Purchase Order Item #
Ask an LLM
“Can I change the quantity or rate of an existing PO line?”
“How do I edit a purchase order item's GL or shipping?”
Tell an agent
Change PO {poID} item {poItemID} quantity to {quantity}.
Update the rate of line {poItemID} on PO {poID} to {rate}.
DELETE /v2/po/{poID}/items/{poItemID} Delete a purchase order line item · Delete PO Item #
Ask an LLM
“What happens to part and task links when a PO item is deleted?”
“Can I remove a line from a purchase order?”
Tell an agent destructive · confirm first
Delete item {poItemID} from purchase order {poID}.
Remove line {poItemID} on PO {poID}.
PUT /v2/po/{poID}/items/{poItemID} Receive a quantity of a PO item · Receive PO Item #
Ask an LLM
“How do I mark part of a purchase order item as received?”
“Does receiving a PO item generate a bill?”
Tell an agent
Receive {quantity} of item {poItemID} on PO {poID}.
Mark PO {poID} line {poItemID} as received in quantity {quantity}.
GET /v2/po/{poID}/comments List comments on a purchase order · PO Comments #
Ask an LLM
“What comments have been left on a purchase order?”
“Can I read the discussion on a PO?”
Tell an agent
Show the comments on PO {poID}.
List comments for purchase order {poID}.
POST /v2/po/{poID}/comments Add a comment to a purchase order · Create PO Comment #
Ask an LLM
“How do I comment on a purchase order?”
“Can I leave a note on a PO for the approver?”
Tell an agent
Add a comment to PO {poID}.
Post a note on purchase order {poID}.
PUT /v2/po/{poID}/comments/{commentID}/file Upload a file to a PO comment · Upload PO Comment File #
Ask an LLM
“Can I attach a quote document to a purchase order comment?”
“How do I add a file to a PO comment?”
Tell an agent
Upload a file to comment {commentID} on PO {poID}.
Attach the quote to purchase order {poID} comment {commentID}.
DELETE /v2/po/{poID}/comments/{commentID}/file Delete a file from a PO comment · Delete PO Comment File #
Ask an LLM
“How do I remove an attachment from a purchase order comment?”
“Can I delete one named file from a PO comment?”
Tell an agent destructive · confirm first
Delete file {filename} from comment {commentID} on PO {poID}.
Remove the attachment on PO {poID} comment {commentID}.
DELETE /v2/po/{poID}/comments/{commentID} Delete a purchase order comment · Delete PO Comment #
Ask an LLM
“Can I delete a comment from a purchase order?”
“How do I remove a PO note posted by mistake?”
Tell an agent destructive · confirm first
Delete comment {commentID} on PO {poID}.
Remove purchase order {poID} comment {commentID}.
PATCH /v2/po/{poID}/state Move a purchase order to its next state · Change PO State #
Ask an LLM
“How do I move a purchase order to ready to receive or closed?”
“Can a PO skip more than one state in a single change?”
Tell an agent
Advance purchase order {poID} to its next state.
Close purchase order {poID}.
GET /v2/po/{poID}/state/transitions Get valid next states for a purchase order · Get PO State Transitions #
Ask an LLM
“Which states can this purchase order move to next?”
“What are the allowed transitions for a PO right now?”
Tell an agent
Show the valid next states for PO {poID}.
List allowed state transitions of purchase order {poID}.
GET /v2/po List purchase orders · Get Purchase Orders #
Ask an LLM
“What purchase orders are open with a certain vendor?”
“Can I look up purchase orders by PO number or status?”
Tell an agent
List purchase orders for vendors {vendors}.
Find purchase orders with numbers {numbers}.
POST /v2/po Create a purchase order · New Purchase Order #
Ask an LLM
“How do I create a new purchase order for a vendor?”
“Can I set an expected delivery date and budget on a new PO?”
Tell an agent
Create a purchase order at location {locationID} for vendor {vendorID}.
Open a new PO at location {locationID} expected on {expectedDate}.
PATCH /v2/po/{poID} Update a purchase order · Update Purchase Order #
Ask an LLM
“Can I change the vendor or budget on an existing purchase order?”
“Can a PO be moved to a different location?”
Tell an agent
Change the vendor on PO {poID} to {vendorID}.
Update purchase order {poID} description to {requestDescription}.
DELETE /v2/po/{poID} Delete a purchase order · Delete PO #
Ask an LLM
“What happens to line items when a purchase order is deleted?”
“Can I delete a PO entirely?”
Tell an agent destructive · confirm first
Delete purchase order {poID}.
Remove PO {poID} and its items.
GET /v2/gl List general ledgers · Get General Ledgers #
Ask an LLM
“Which GL accounts are set up for purchasing?”
“Can I find a general ledger by its abbreviation?”
Tell an agent
List general ledgers at locations {locations}.
Find the GL with abbreviation {abbr}.
POST /v2/gl Create a general ledger · New General Ledger #
Ask an LLM
“How do I create a new GL account for a location?”
“Can a new general ledger be tied to an asset?”
Tell an agent
Create GL {name} with abbreviation {abbr} at location {locationID}.
Create a general ledger at location {locationID} linked to asset {assetID}.
PATCH /v2/gl/{glID} Update a general ledger · Update General Ledger #
Ask an LLM
“Can I rename a GL or change its abbreviation?”
“How do I link an existing general ledger to an asset?”
Tell an agent
Rename general ledger {glID} to {name}.
Associate GL {glID} with asset {assetID}.
DELETE /v2/gl/{glID} Delete a general ledger · Delete General Ledger #
Ask an LLM
“What happens to PO items when their GL is deleted?”
“Can I remove a general ledger account?”
Tell an agent destructive · confirm first
Delete general ledger {glID}.
Remove GL {glID}.
POST /v2/budgets/{budgetID}/steps Add an approval step to a budget · New Step #
Ask an LLM
“How do I add a PO workflow approval step to a budget?”
“Can a budget step send an email or allow editing of the PO?”
Tell an agent
Add step {name} to budget {budgetID}.
Create approval step {name} on budget {budgetID} assigned to {assignment}.
DELETE /v2/budgets/{budgetID}/steps/{stepID} Delete a budget step · Delete Step #
Ask an LLM
“Can I remove an approval step from a budget's PO workflow?”
“How do I delete a budget workflow step?”
Tell an agent destructive · confirm first
Delete step {stepID} from budget {budgetID}.
Remove workflow step {stepID} on budget {budgetID}.
PATCH /v2/budgets/{budgetID}/steps/{stepID} Update a budget step · Update Step #
Ask an LLM
“Can I rename or reorder a PO workflow step?”
“How do I change who is assigned to a budget approval step?”
Tell an agent
Rename step {stepID} on budget {budgetID} to {name}.
Move budget {budgetID} step {stepID} to position {order}.
GET /v2/budgets/steps List budget workflow steps · Get Steps #
Ask an LLM
“What approval steps are in my PO workflows?”
“Can I see the steps for a particular budget?”
Tell an agent
List steps for budgets {budgets}.
Find the budget step named {name}.
GET /v2/budgets List budgets · Get Budgets #
Ask an LLM
“What budgets are configured for purchasing?”
“Which budget is used at a certain location?”
Tell an agent
List all budgets.
Show budgets at locations {locations}.
POST /v2/budgets Create a budget · New Budget #
Ask an LLM
“How do I create a new purchasing budget for a location?”
“Can I make a new budget the default one?”
Tell an agent
Create budget {name} at location {locationID}.
Create a default budget at location {locationID} ({defaultBudget}).
DELETE /v2/budgets/{budgetID} Delete a budget · Delete Budget #
Ask an LLM
“Can I remove a purchasing budget?”
“How do I delete a budget I no longer use?”
Tell an agent destructive · confirm first
Delete budget {budgetID}.
Remove purchasing budget {budgetID}.
PATCH /v2/budgets/{budgetID} Update a budget · Update Budget #
Ask an LLM
“Can I rename a budget or change its purchase request assignments?”
“How do I make an existing budget the default?”
Tell an agent
Rename budget {budgetID} to {name}.
Set budget {budgetID} as the default ({defaultBudget}).
GET /v2/priorities List task priorities · Get Priorities #
Ask an LLM
“What priority levels are defined for work orders?”
“Which priority is the default?”
Tell an agent
List all priorities.
Show priorities {priorities}.
POST /v2/priorities Create a task priority · New Priority #
Ask an LLM
“How do I add a new priority level like Critical?”
“Can adding a priority reorder the other priorities?”
Tell an agent
Create priority {name}.
Add priority {name} at level {priorityLevel} with color {color}.
PATCH /v2/priorities/{priorityID} Update a task priority · Update Priority #
Ask an LLM
“Can I rename a priority or make it the default?”
“How do I edit an existing priority level?”
Tell an agent
Rename priority {priorityID} to {name}.
Make priority {priorityID} the default ({isDefault}).
DELETE /v2/priorities/{priorityID} Delete a task priority · Delete Priority #
Ask an LLM
“What happens to other priorities when I remove one?”
“Can I delete a priority level?”
Tell an agent destructive · confirm first
Delete priority {priorityID}.
Remove priority level {priorityID}.
GET /v2/tags List account tags · Get Tags #
Ask an LLM
“What custom tags exist in my account?”
“Is there a tag matching a search term?”
Tell an agent
List all account tags.
Search tags for {name}.
POST /v2/tags Create an account tag · Create Account Tag #
Ask an LLM
“How do I create a new custom tag for tasks?”
“Is a tag name normalized when created?”
Tell an agent
Create account tag {name}.
Add a new custom tag called {name}.
PATCH /v2/tags/{oldName} Rename an account tag · Rename Account Tag #
Ask an LLM
“Does renaming a tag update every task that uses it?”
“How do I rename a custom tag?”
Tell an agent
Rename tag {oldName} to {newName}.
Change account tag {oldName} to {newName} everywhere.
DELETE /v2/tags/{oldName} Delete an account tag everywhere · Delete Account Tag #
Ask an LLM
“What happens to tasks and dashboards when an account tag is deleted?”
“Can I delete a custom tag from the whole account?”
Tell an agent destructive · confirm first
Delete account tag {oldName}.
Remove tag {oldName} from the account and everything using it.
GET /v2/statuses List custom task statuses · Statuses #
Ask an LLM
“What custom task statuses are defined?”
“Is there a status called Waiting on Parts?”
Tell an agent
List all task statuses.
Find the status named {name}.
POST /v2/statuses Create a custom task status · Create Status #
Ask an LLM
“How do I add a custom status for tasks?”
“Do custom status names have to be unique?”
Tell an agent
Create status {name}.
Add status {name} described as {description} at sort position {sortOrder}.
PATCH /v2/statuses/{statusID} Update a custom task status · Update Status #
Ask an LLM
“Can I rename a custom status or change its sort order?”
“Can the default statuses be modified?”
Tell an agent
Rename status {statusID} to {name}.
Move status {statusID} to sort position {sortOrder}.
DELETE /v2/statuses/{statusID} Delete a custom task status · Delete Status #
Ask an LLM
“What happens to tasks using a status I delete?”
“Can the default statuses be deleted?”
Tell an agent destructive · confirm first
Delete status {statusID} and move its tasks to status {replacementStatusID}.
Remove custom status {statusID}.
POST /v2/bills/{billID}/transactions Add an item to a bill · Add Bill Item #
Ask an LLM
“How do I add a received PO item to an unclosed bill?”
“Can I record the quantity received on a bill line?”
Tell an agent
Add PO item {poItemID} to bill {billID}.
Record {qtyReceived} received of PO item {poItemID} on bill {billID}.
GET /v2/bills/transactions List bill transactions · Bill Transactions #
Ask an LLM
“What transactions have been recorded on my bills?”
“Can I filter bill transactions by date or location?”
Tell an agent
List transactions for bills {bills}.
Show bill transactions between {start} and {end}.
PATCH /v2/bills/{billID}/transactions/{transactionID} Update a bill transaction · Update Bill Transaction #
Ask an LLM
“Can I correct the quantity received on a bill transaction?”
“How do I edit a line on a bill?”
Tell an agent
Change transaction {transactionID} on bill {billID} to quantity {qtyReceived}.
Update bill {billID} transaction {transactionID}.
DELETE /v2/bills/transactions/{transactionID} Delete a bill transaction · Bill Transaction #
Ask an LLM
“Can I remove a transaction from a bill?”
“How do I delete a wrong bill line?”
Tell an agent destructive · confirm first
Delete bill transaction {transactionID}.
Remove transaction {transactionID} from its bill.
GET /v2/bills/{billID}/comments List comments on a bill · Bill Comments #
Ask an LLM
“What comments are on a bill?”
“Can I read the notes left on a bill?”
Tell an agent
Show the comments on bill {billID}.
List comments for bill {billID}.
POST /v2/bills/{billID}/comments Add a comment to a bill · Create Bill Comment #
Ask an LLM
“How do I comment on a bill?”
“Can I leave a note on a bill for accounting?”
Tell an agent
Add a comment to bill {billID}.
Post a note on bill {billID}.
PUT /v2/bills/{billID}/comments/{commentID}/file Upload a file to a bill comment · Upload Bill Comment File #
Ask an LLM
“Can I attach a document to a bill comment?”
“How do I add a file to a comment on a bill?”
Tell an agent
Upload a file to comment {commentID} on bill {billID}.
Attach the vendor invoice to bill {billID} comment {commentID}.
DELETE /v2/bills/{billID}/comments/{commentID}/file Delete a file from a bill comment · Delete Bill Comment File #
Ask an LLM
“How do I remove an attachment from a bill comment?”
“Can I delete one named file from a bill comment?”
Tell an agent destructive · confirm first
Delete file {filename} from comment {commentID} on bill {billID}.
Remove the attachment on bill {billID} comment {commentID}.
DELETE /v2/bills/{billID}/comments/{commentID} Delete a bill comment · Delete Bill Comment #
Ask an LLM
“Can I delete a comment from a bill?”
“How do I remove a bill note posted by mistake?”
Tell an agent destructive · confirm first
Delete comment {commentID} on bill {billID}.
Remove bill {billID} comment {commentID}.
GET /v2/bills List bills · Get Bills #
Ask an LLM
“What bills exist for my purchase orders?”
“Can I look up bills by bill number or status?”
Tell an agent
List bills for purchase orders {pos}.
Find bills with numbers {numbers}.
POST /v2/bills Create a bill for a purchase order · New Bill #
Ask an LLM
“How do I create a bill against a purchase order?”
“Can I assign a new bill to a user?”
Tell an agent
Create a bill for PO {poID}.
Create a bill for purchase order {poID} assigned to user {userID}.
PATCH /v2/bills/{billID} Update a bill · Update Bill #
Ask an LLM
“Can I reassign a bill or change its status?”
“How do I update a bill?”
Tell an agent
Assign bill {billID} to user {userID}.
Set the status of bill {billID} to {status}.
DELETE /v2/bills/{billID} Delete a bill · Delete Bill #
Ask an LLM
“What happens to received PO items when a bill is deleted?”
“Can I delete a bill?”
Tell an agent destructive · confirm first
Delete bill {billID}.
Remove bill {billID} and its transactions.
POST /v2/regions Create a region · Create Region #
Ask an LLM
“How do I create a region to group locations?”
“What does a new region need?”
Tell an agent
Create a new region.
Add a region called Southeast.
GET /v2/regions List regions · Regions #
Ask an LLM
“What regions are my locations grouped into?”
“Is there a region called West?”
Tell an agent
List all regions.
Find the region named {name}.
PATCH /v2/regions/{regionID} Update a region · Update Region #
Ask an LLM
“Can I rename a region?”
“How do I edit a region?”
Tell an agent
Update region {regionID}.
Rename region {regionID}.
DELETE /v2/regions/{regionID} Delete a region · Delete Region #
Ask an LLM
“Can I delete a region?”
“How do I remove a region grouping?”
Tell an agent destructive · confirm first
Delete region {regionID}.
Remove region {regionID}.
GET /v2/webhooks List webhooks · Get Webhooks #
Ask an LLM
“What webhooks are configured on my account?”
“Which webhooks are currently enabled?”
Tell an agent
List all webhooks.
Show webhooks of type {type}.
POST /v2/webhooks Create a webhook · New Webhook #
Ask an LLM
“How do I subscribe a URL to CMMS events with a webhook?”
“Are new webhooks enabled by default?”
Tell an agent
Create a webhook of type {type} sending to {endpoint}.
Register {endpoint} as a disabled webhook of type {type} ({enabled}).
DELETE /v2/webhooks/{webhookID} Delete a webhook · Delete Webhook #
Ask an LLM
“How do I stop and remove a webhook?”
“Can I delete a webhook subscription?”
Tell an agent destructive · confirm first
Delete webhook {webhookID}.
Remove webhook subscription {webhookID}.
PATCH /v2/webhooks/{webhookID} Update a webhook · Update Webhook #
Ask an LLM
“Can I change a webhook's URL or disable it?”
“How do I turn a webhook off without deleting it?”
Tell an agent
Point webhook {webhookID} at {endpoint}.
Set webhook {webhookID} enabled to {enabled}.
GET /v2/uom List units of measure · Get Units #
Ask an LLM
“What units of measure are available for parts?”
“Can I look up units by abbreviation prefix?”
Tell an agent
List all units of measure.
Find units whose abbreviation starts with {abbreviationStartsWith}.
POST /v2/uom Create a custom unit of measure · Create Unit #
Ask an LLM
“How do I add a custom unit like pallets?”
“What fields does a custom unit need?”
Tell an agent
Create unit {name} with abbreviation {abbreviation}.
Add a custom unit of measure called {name}.
PATCH /v2/uom/{unitCode} Update a unit of measure · Update Unit #
Ask an LLM
“Can I rename a custom unit or change its abbreviation?”
“How do I edit an existing unit of measure?”
Tell an agent
Rename unit {unitCode} to {name}.
Change the abbreviation of unit {unitCode} to {abbreviation}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/limble-cmms:limble-cmms-routes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

limble-cmms-routes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Limble API V2 Routes API
  version: 1.0.0
  description: Getting Started!
servers:
- url: '{{server}}:{{port}}'
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (520 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/limble-cmms/refs/heads/main/openapi/limble-cmms-routes-api-openapi.yml