Maintainx

Learn how to use Maintainx with Composio

Overview

Enum

MAINTAINX

Description

MaintainX is a cloud-based computerized maintenance management system (CMMS) that helps organizations centralize maintenance data, communication, and workflows.

Authentication Details

api_key
stringRequired

Actions

This 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.

Action Parameters

asset_id
integer
categories
array
description
string
due_date
string
location_id
integer
priority
string
procedure_template_id
integer
start_date
string
team_ids
array
title
stringRequired
user_ids
array

Action Response

data
object
error
successful
boolean

This 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.

Action Parameters

content
stringRequired
work_order_id
integerRequired

Action Response

data
object
error
successful
boolean

Creates 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.

Action Parameters

asset_id
integer
contact_information
string
description_placeholder
string
email_only
boolean
location_id
integer
send_email_notification
boolean
title
stringRequired
welcome_text
string

Action Response

data
object
error
successful
boolean

A 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.

Action Parameters

entity_type
stringRequired
limit
integer
offset
integer
search_query
stringRequired
sort_by
string
sort_order
string
status
string

Action Response

data
object
error
successful
boolean

This tool allows users to retrieve a list of all assets in their organization.

Action Parameters

cursor
string
custom_field_name
array
expand
array
limit
integerDefaults to 100
location_id
integer

Action Response

data
object
error
successful
boolean

This 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.

Action Parameters

cursor
string
limit
integer

Action Response

data
object
error
successful
boolean

This 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.

Action Parameters

cursor
string
limit
integerDefaults to 100

Action Response

data
object
error
successful
boolean

This tool retrieves a list of all teams in your maintainx organization.

Action Parameters

Action Response

data
object
error
successful
boolean

Action to list work orders from maintainx.

Action Parameters

assets
array
assignees
array
categories
array
cursor
string
expand
array
limit
integer
locations
array
notAssets
array
notCategories
array
notLocations
array
notParts
array
notVendors
array
parts
array
priorities
array
show_upcoming
boolean
sort
string
statuses
array
teams
array
title
string
vendors
array

Action Response

data
object
error
successful
boolean

This 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.

Action Parameters

description
string
priority
string
title
string
workorder_id
stringRequired

Action Response

data
object
error
successful
boolean

This 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.

Action Parameters

status
stringRequired
workorder_id
stringRequired

Action Response

data
object
error
successful
boolean