Skip to main content
Maintainx logo
  • Category: task management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: MAINTAINX
  • Version: 20261101_00

Tools

Slug: 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

string
required
Category label used when displaying the category
string
Description field for additional information about the category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the location
string
Physical postal address of the location
string
String encoded barcode for the location
integer
ID of the parent location to create a hierarchical structure
array
List of vendor IDs associated with this location
string
Description of the location
object
Custom fields on the location. The object keys are the exact Custom Field labels, including spaces or special characters (e.g., ‘Department’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_CREATE_PROCEDURE_TEMPLATECreate a MaintainX procedure template for work orders, with fields such as text, checkboxes, signatures, and multiple choice options. A supplied template-level description is not sent.

Input Parameters

string
required
Title of the procedure template
array
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.
string
Description of the procedure template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_CREATE_WORK_ORDERCreates a new work order in MaintainX with a required title and optional description, priority, dates, user and team assignees, procedure template, location, asset, and categories.

Input Parameters

string
required
The title of the work order
integer
ID of the asset associated with the work order
string
Due date for the work order in ISO 8601 format (e.g., 2024-03-15T14:30:00Z)
string ("NONE" | "LOW" | "MEDIUM" | "HIGH")
Priority level of the work order (NONE, LOW, MEDIUM, HIGH)
array
List of team IDs to assign to the work order
array
List of user IDs to assign to the work order
array
List of categories for the work order
string
Start date for the work order in ISO 8601 format (e.g., 2024-03-15T14:30:00Z)
string
Detailed description of the work order
integer
ID of the location where the work is to be performed
integer
ID of an existing procedure template to attach to the work order. The template must exist and be accessible in the MaintainX account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The text content of the comment
integer
required
The ID of the work order to add the comment to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Title of the work request
integer
ID of the asset associated with the work request
string ("NONE" | "LOW" | "MEDIUM" | "HIGH")
Priority levels for work requests.
string
Description of the work request
integer
ID of the location associated with the work request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Title of the portal
integer
ID of the asset related to the portal
boolean
Allow request creation with email only to contact the requester
integer
ID of the location where the portal is located
string
Description text describing the portal
string
Contact of the person creating the portal (email or phone number)
string
Placeholder text for the description field
boolean
Send email notifications to the portal requesters with status updates on their requests

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the asset to delete. Must be a valid integer.
boolean
Set to true to skip all webhooks upon successful deletion of the asset. Learn more about webhooks in the MaintainX API documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the category to delete
boolean
Set to true to skip all webhooks upon successful deletion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_FIND_ENTITYSearch MaintainX work orders by title, locations and assets by name, and users by email, or list teams. User queries without an @ and all team queries are not applied as filters; the result count may reflect only the returned page.

Input Parameters

integer
Max number of results to return (1-200)
integer
Number of items to skip for pagination
string
Filter by status (applicable for workorders)
string
Field to sort results by
string
Sort order (asc or desc)
string ("workorders" | "users" | "locations" | "assets" | "teams")
required
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_GET_ASSETRetrieve detailed information about a MaintainX asset by its ID.

Input Parameters

integer
required
ID of the asset to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the location to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_GET_PURCHASE_ORDERRetrieve one MaintainX purchase order by ID.

Input Parameters

integer
required
ID of the purchase order to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the vendor to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_GET_WORK_ORDERRetrieve one MaintainX work order by ID with optional related-record expansions.

Input Parameters

array
Related work order fields to expand. Values are sent as repeated query parameters.
integer
required
ID of the work order to retrieve
boolean
Treat work_order_id as the tenant-visible sequential ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the work order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Will only show asset importances that match the label
integer
Will only show asset importances that match the level
integer
Max number of Asset Criticalities returned
string
Last pagination reference
integer
Required if using a multi organizations token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_ASSETSThis tool allows users to retrieve a list of all assets in their organization.

Input Parameters

integer
Max number of Assets returned (1-200)
string
Last pagination reference
array
Fields to expand in the response
integer
Will only show assets that are related to the location
array
Filter assets by custom field value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_CATEGORIESList categories in the MaintainX organization with pagination. Returned category details include ID, label, and description.

Input Parameters

integer
Max number of Categories returned (1-200). Default is 100.
string
Last pagination reference

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Max number of Locations returned (1-200)
string
Last pagination reference

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_METERSTool to list all meters in your organization. Use this to retrieve meter information including measurement types, units, and readings.

Input Parameters

integer
Max number of Meters returned (1-100)
string
Last pagination reference for retrieving the next page of results
array
Fields to expand in the response (e.g., asset, location). To expand multiple fields, pass multiple values.
string ("MANUAL" | "IOT_DEVICE" | "AUTOMATED_SENSOR")
Enum for meter measurement types.
integer
Required if using a multi organizations token. Specifies which organization to query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Max number of parts returned
string
Last pagination reference
integer
Filter by location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Max number of procedure templates returned (1-200)
string
Last pagination reference

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_TEAMSThis tool retrieves a list of all teams in your MaintainX organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_WORK_ORDER_COMMENTSList one cursor-paginated page of comments attached to a work order.

Input Parameters

integer
Maximum number of comments to return (1-200)
string
Pagination cursor returned by a previous request
integer
required
The ID of the work order whose comments will be listed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_WORK_ORDERSAction to list work orders from MaintainX.

Input Parameters

string
Sort attribute
integer
Max number of Work Orders returned (1-200)
array
Filter by part IDs
array
Filter by team IDs
string
Filter work orders by title
array
Filter by asset IDs
string
Last pagination reference
array
Expand specific fields in response
array
Filter by vendor IDs
array
Filter by statuses
array
Filter by assignee IDs
array
Filter by location IDs
array
Exclude work orders with specified parts
array
Filter by categories
array
Exclude work orders with specified assets
array
Filter by priorities
array
Exclude work orders with specified vendors
array
Exclude work orders with specified locations
boolean
Include work orders with future start date
array
Exclude work orders with specified categories

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_LIST_WORK_REQUEST_PORTALSLists work request portals in your MaintainX organization for managing external work requests. Results are paginated using a cursor and limit.

Input Parameters

integer
Max number of Work Request Portals returned
string
Last pagination reference

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Max number of work requests returned (1-200)
string
Last pagination reference for retrieving the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_UPDATE_ASSETUpdate selected fields on an existing MaintainX maintenance asset.

Input Parameters

string
New asset name.
object
Asset model reference accepted by MaintainX.
string
New barcode, or null to clear.
integer
required
ID of the asset to update.
array
IDs of teams responsible for the asset.
integer
Parent asset ID, or null to clear.
array
Vendor IDs associated with the asset.
array
Asset type labels.
string
New description, or null to clear.
string
Organization-unique external ID, or null to clear.
integer
Location ID, or null to clear.
object
Documented MaintainX asset depreciation shape.
object
Custom field labels mapped to string values.
object
Manufacturer reference accepted by MaintainX.
boolean
Whether to skip webhooks for this update.
string
Serial number, or null to clear.
integer
Criticality ID, or null to clear.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAINTAINX_UPDATE_LOCATIONUpdate selected fields on an existing MaintainX maintenance location.

Input Parameters

string
New location name.
string
New postal address, or null to clear.
string
New barcode, or null to clear.
integer
Parent location ID, or null to clear.
array
Vendor IDs associated with the location.
string
New location description, or null to clear.
string
Organization-unique external ID, or null to clear.
integer
required
ID of the location to update.
object
Custom field labels mapped to string values.
boolean
Whether to skip webhooks for this update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the vendor.
object
required
File to upload.
string
required
Name of the attachment, including the extension.
boolean
Set to true to skip all webhooks upon successful operation on the endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
New title for the work order. At least one of title, description, or priority must be provided.
string
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.
string
New description for the work order. At least one of title, description, or priority must be provided.
string
required
The ID of the work order to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("OPEN" | "IN_PROGRESS" | "ON_HOLD" | "DONE")
required
The new status for the work order
integer
required
The ID of the work order to update. Must be a valid integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
ID of the work request portal to update
string
Title of the portal
integer
ID of the asset related to the portal
boolean
Allow request creation with email only to contact the requester
integer
ID of the location where the portal is located
boolean
Set to true to skip all webhooks upon successful operation on the endpoint
string
Description text describing the portal
string
Contact of the person creating the portal (email or phone number)
string
Placeholder text for the description field
boolean
Send email notifications to the portal requesters with status updates on their requests

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not