NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Maintainx connects to a Nagent workspace with an API key. Once it is connected, agents can call 30 Maintainx actions, such as "Create Category", "Create Location" and "Create Procedure Template". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Maintainx, with input parameters and output schema.
MAINTAINX_CREATE_CATEGORYTool to create a new category in MaintainX for organizing work orders, assets, and other items. Use when you need to add a new category to the organization's classification system.
Input parameters
Category label used when displaying the category
Description field for additional information about the category
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_CREATE_LOCATIONTool to create a new location in MaintainX. Use when you need to add a new physical location where assets are stored or work is performed. Locations can be organized hierarchically using the parentId parameter.
Input parameters
Name of the location
Physical postal address of the location
String encoded barcode for the location
ID of the parent location to create a hierarchical structure
List of vendor IDs associated with this location
Description of the location
Custom fields on the location. The object keys are the exact Custom Field labels, including spaces or special characters (e.g., 'Department')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_CREATE_PROCEDURE_TEMPLATETool to create a new procedure template in MaintainX with checklist items for work orders. Use when you need to create a standardized procedure that can be attached to work orders. The template can include various field types like text, checkboxes, signatures, and multiple choice options.
Input parameters
Title of the procedure template
Array of procedure fields/rows that define the steps in the procedure. Can be an empty list to create a template without pre-defined fields.
Description of the procedure template
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_CREATE_WORK_ORDERThis tool creates a new work order in MaintainX. It uses the POST /api/v1/workorders endpoint. The tool requires a 'title' for the work order and offers several optional parameters including description, priority, dueDate, startDate, userIds, teamIds, procedureTemplateId, locationId, assetId, and categories.
Input parameters
The title of the work order
ID of the asset associated with the work order
Due date for the work order in ISO 8601 format (e.g., 2024-03-15T14:30:00Z)
Priority level of the work order (NONE, LOW, MEDIUM, HIGH)
List of team IDs to assign to the work order
List of user IDs to assign to the work order
List of categories for the work order
Start date for the work order in ISO 8601 format (e.g., 2024-03-15T14:30:00Z)
Detailed description of the work order
ID of the location where the work is to be performed
ID of an existing procedure template to attach to the work order. The template must exist and be accessible in the MaintainX account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_CREATE_WORK_ORDER_COMMENTThis tool creates a new comment on an existing work order in MaintainX. It allows users to add comments for documentation, updates, or communication purposes within a specific work order. It requires a workOrderId and the text content of the comment to create a new comment on the work order, providing capabilities to update maintenance work order records.
Input parameters
The text content of the comment
The ID of the work order to add the comment to
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_CREATE_WORK_REQUESTTool to create a new work request in MaintainX. Use when you need to submit a request for work that can later be converted to a work order. Work requests are typically used to initiate maintenance or service requests that require approval before becoming work orders.
Input parameters
Title of the work request
ID of the asset associated with the work request
Priority levels for work requests.
Description of the work request
ID of the location associated with the work request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_CREATE_WORK_REQUEST_PORTALCreates a new work request portal in MaintainX. A work request portal allows users to submit work requests through a dedicated URL. The portal can be customized with a title, welcome text, and description placeholder. It can be associated with a specific location and asset, and can be configured to require email contact information.
Input parameters
Title of the portal
ID of the asset related to the portal
Allow request creation with email only to contact the requester
ID of the location where the portal is located
Description text describing the portal
Contact of the person creating the portal (email or phone number)
Placeholder text for the description field
Send email notifications to the portal requesters with status updates on their requests
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_DELETE_ASSETSTool to delete an asset from MaintainX by its ID. Use when you need to permanently remove an asset from the system. Returns a success confirmation upon successful deletion (HTTP 204).
Input parameters
ID of the asset to delete. Must be a valid integer.
Set to true to skip all webhooks upon successful deletion of the asset. Learn more about webhooks in the MaintainX API documentation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_DELETE_CATEGORYTool to delete a category in MaintainX. Use when you need to remove a category from the system. Returns success status upon deletion (HTTP 204).
Input parameters
ID of the category to delete
Set to true to skip all webhooks upon successful deletion
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_FIND_ENTITYA tool to search and find specific entities within MaintainX by specified fields. This tool allows users to search for different types of entities including work orders, users, and locations.
Input parameters
Max number of results to return (1-200)
Number of items to skip for pagination
Filter by status (applicable for workorders)
Field to sort results by
Sort order (asc or desc)
Type of entity to search for. Supported types: 'workorders' (searchable by title), 'locations' (searchable by name), 'assets' (searchable by name), 'users' (filterable by email only), 'teams' (no search/filter supported). Note: This is NOT the search query - use 'search_query' parameter to specify what you're searching for.
Text to filter entities. For 'workorders' filters by title, for 'locations' and 'assets' filters by name, for 'users' filters by email (must be valid email format). Not supported for 'teams' endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_GET_CATEGORYTool to retrieve detailed information about a specific category by its ID. Use when you need to get the label, description, update time, or work order count for a category.
Input parameters
ID of the category to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_GET_LOCATIONTool to retrieve detailed information about a specific location by its ID. Use when you need to get comprehensive details including address, attachments, child locations, and custom fields for a location.
Input parameters
ID of the location to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_GET_USERTool to retrieve detailed information about a specific user by their ID. Use when you need to get user data including name, email, role, hourly rate, and custom fields.
Input parameters
ID of the user to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_GET_VENDORTool to retrieve detailed information about a specific vendor by its ID. Use when you need to get comprehensive details about a vendor including contact information, attachments, and custom fields.
Input parameters
ID of the vendor to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_GET_WORKORDERS_COSTSTool to retrieve costs information for a specific work order by its ID. Use when you need to get detailed cost breakdown including total costs and individual cost rows for a work order.
Input parameters
ID of the work order
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_ASSET_CRITICALITIESTool to retrieve a list of asset criticalities from MaintainX. Use when you need to get all available asset criticality levels in the organization, optionally filtered by label or level.
Input parameters
Will only show asset importances that match the label
Will only show asset importances that match the level
Max number of Asset Criticalities returned
Last pagination reference
Required if using a multi organizations token
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_ASSETSThis tool allows users to retrieve a list of all assets in their organization.
Input parameters
Max number of Assets returned (1-200)
Last pagination reference
Fields to expand in the response
Will only show assets that are related to the location
Filter assets by custom field value
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_CATEGORIESThis tool retrieves a list of all categories in your MaintainX organization. Categories are used to organize and classify work orders, assets, and other items in the system. It supports listing the categories with pagination and provides details such as category_id, name, description, and timestamps for creation and update.
Input parameters
Max number of Categories returned (1-200). Default is 100.
Last pagination reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_LOCATIONSThis tool retrieves a list of all available locations in the organization's MaintainX account. The locations can be physical places where assets are located, work is performed, or maintenance is needed.
Input parameters
Max number of Locations returned (1-200)
Last pagination reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_METERSTool to list all meters in your organization. Use this to retrieve meter information including measurement types, units, and readings.
Input parameters
Max number of Meters returned (1-100)
Last pagination reference for retrieving the next page of results
Fields to expand in the response (e.g., asset, location). To expand multiple fields, pass multiple values.
Enum for meter measurement types.
Required if using a multi organizations token. Specifies which organization to query.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_PARTSTool to list parts/inventory items with pagination and filtering. Use when you need to retrieve available parts from the organization's inventory.
Input parameters
Max number of parts returned
Last pagination reference
Filter by location ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_PROCEDURE_TEMPLATESTool to list procedure templates from MaintainX. Use when you need to retrieve available procedure templates that can be used in work orders.
Input parameters
Max number of procedure templates returned (1-200)
Last pagination reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_TEAMSThis tool retrieves a list of all teams in your MaintainX organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_WORK_ORDERSAction to list work orders from MaintainX.
Input parameters
Sort attribute
Max number of Work Orders returned (1-200)
Filter by part IDs
Filter by team IDs
Filter work orders by title
Filter by asset IDs
Last pagination reference
Expand specific fields in response
Filter by vendor IDs
Filter by statuses
Filter by assignee IDs
Filter by location IDs
Exclude work orders with specified parts
Filter by categories
Exclude work orders with specified assets
Filter by priorities
Exclude work orders with specified vendors
Exclude work orders with specified locations
Include work orders with future start date
Exclude work orders with specified categories
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_WORK_REQUEST_PORTALSTool to list all work request portals in your MaintainX organization. Use when you need to retrieve available work request portals for managing external work requests.
Input parameters
Max number of Work Request Portals returned
Last pagination reference
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_LIST_WORK_REQUESTSTool to retrieve a list of work requests from MaintainX. Use when you need to view all work requests. Supports pagination for large result sets using cursor and limit parameters.
Input parameters
Max number of work requests returned (1-200)
Last pagination reference for retrieving the next page of results
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_UPDATE_VENDORS_ATTACHMENTTool to update a vendor attachment in MaintainX. Use when you need to upload or replace a file attachment for a specific vendor. The file is uploaded as binary data.
Input parameters
ID of the vendor.
File to upload.
Name of the attachment, including the extension.
Set to true to skip all webhooks upon successful operation on the endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_UPDATE_WORK_ORDERThis tool allows users to update an existing work order in MaintainX by modifying specific attributes without affecting other unchanged fields. It requires the workorder_id and at least one of the optional parameters (title, description, or priority) to perform the update.
Input parameters
New title for the work order. At least one of title, description, or priority must be provided.
New priority level for the work order. Must be one of: LOW, MEDIUM, HIGH. At least one of title, description, or priority must be provided.
New description for the work order. At least one of title, description, or priority must be provided.
The ID of the work order to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_UPDATE_WORK_ORDER_STATUSThis tool allows users to update the status of a specific work order in MaintainX. It is focused specifically on status updates, making it more streamlined than the comprehensive 'Update Work Order' action which allows updating multiple fields.
Input parameters
The new status for the work order
The ID of the work order to update. Must be a valid integer.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MAINTAINX_UPDATE_WORK_REQUEST_PORTALUpdates an existing work request portal in MaintainX. Tool to update work request portal information such as title, welcome text, contact information, and notification settings. Use when modifying an existing portal's configuration.
Input parameters
ID of the work request portal to update
Title of the portal
ID of the asset related to the portal
Allow request creation with email only to contact the requester
ID of the location where the portal is located
Set to true to skip all webhooks upon successful operation on the endpoint
Description text describing the portal
Contact of the person creating the portal (email or phone number)
Placeholder text for the description field
Send email notifications to the portal requesters with status updates on their requests
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 30 Maintainx actions on Nagent, including "Create Category", "Create Location" and "Create Procedure Template". Create Category: Create a new category in MaintainX for organizing work orders, assets, and other items. Each action is listed on this page with its input parameters and its output.
Maintainx connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Category takes 1 required input: label. It also takes 1 optional input: description. It returns data, error and successful.