MaintainX

MaintainX integration (Productivity, Data). Imported from open-connector.

API key16 toolshttps://api.getmaintainx.com/v1

GET

maintainx_list_work_orders

List MaintainX work orders with filters and cursor pagination.

/workorders

22 parameters

Param	Type	Required	Description
cursor	string	optional	MaintainX pagination cursor from a previous response.
limit	integer	optional	Maximum number of records to return.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
title	string	optional	Filter MaintainX work orders by title.
assets	array	optional	Asset ids to include.
notAssets	array	optional	Asset ids to exclude.
locations	array	optional	Location ids to include.
notLocations	array	optional	Location ids to exclude.
parts	array	optional	Part ids to include.
notParts	array	optional	Part ids to exclude.
vendors	array	optional	Vendor ids to include.
notVendors	array	optional	Vendor ids to exclude.
assignees	array	optional	Assignee user ids to include.
teams	array	optional	Team ids to include.
categories	array	optional	Categories to include.
notCategories	array	optional	Categories to exclude.
priorities	array	optional	Work order priorities to include.
statuses	array	optional	Work order statuses to include.
partStatuses	array	optional	Part statuses to include.
showUpcoming	boolean	optional	Whether to include work orders with future start dates.
sort	string	optional	MaintainX work order sort attribute.
expand	array	optional	MaintainX work order fields to expand.

GET

maintainx_get_work_order

Retrieve one MaintainX work order by global id.

/workorders/{workOrderId}

4 parameters

Param	Type	Required	Description
id	integer	required	MaintainX work order id.
expand	array	optional	MaintainX work order fields to expand.
useSequentialId	boolean	optional	Whether the id is the organization-specific sequential id.
workOrderId	string	required	Path parameter: workOrderId

POST

maintainx_create_work_order

Create a MaintainX work order.

/workorders

23 parameters

Param	Type	Required	Description
title	string	required	MaintainX work order title.
description	string	optional	—
assetId	integer	optional	—
locationId	integer	optional	—
priority	string	optional	MaintainX work order priority.
type	string	optional	MaintainX work order type.
dueDate	string	optional	—
startDate	string	optional	—
estimatedTime	integer	optional	—
requesterId	integer	optional	MaintainX requester id or requester email address.
categories	array	optional	Categories assigned to the work order.
assignees	array	optional	MaintainX users or teams assigned to the work order.
externalData	object	optional	—
extraFields	object	optional	MaintainX custom fields keyed by exact custom field labels.
vendorIds	array	optional	Vendor ids assigned to the work order.
partsUsed	array	optional	Parts used in this MaintainX work order.
workRequestId	integer	optional	—
workOrderTemplateId	integer	optional	—
procedureTemplateId	number	optional	—
parentId	number	optional	—
isParent	boolean	optional	—
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.

PATCH

maintainx_update_work_order

Update a MaintainX work order.

/workorders/{workOrderId}

25 parameters

Param	Type	Required	Description
id	integer	required	MaintainX work order id.
title	string	optional	MaintainX work order title.
description	string	optional	—
assetId	integer	optional	—
locationId	integer	optional	—
priority	string	optional	MaintainX work order priority.
type	string	optional	MaintainX work order type.
dueDate	string	optional	—
startDate	string	optional	—
estimatedTime	integer	optional	—
requesterId	integer	optional	MaintainX requester id or requester email address.
categories	array	optional	Categories assigned to the work order.
assignees	array	optional	MaintainX users or teams assigned to the work order.
externalData	object	optional	—
extraFields	object	optional	MaintainX custom fields keyed by exact custom field labels.
vendorIds	array	optional	Vendor ids assigned to the work order.
partsUsed	array	optional	Parts used in this MaintainX work order.
workRequestId	integer	optional	—
workOrderTemplateId	integer	optional	—
procedureTemplateId	number	optional	—
parentId	number	optional	—
isParent	boolean	optional	—
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.
expand	array	optional	MaintainX work order fields to expand in the response.
workOrderId	string	required	Path parameter: workOrderId

PATCH

maintainx_update_work_order_status

Update the status of a MaintainX work order.

/workorders/{workOrderId}/status

4 parameters

Param	Type	Required	Description
id	integer	required	MaintainX work order id.
status	string	required	MaintainX status to set on the work order.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.
workOrderId	string	required	Path parameter: workOrderId

GET

maintainx_list_work_order_comments

List comments on a MaintainX work order.

/workorders/{workOrderId}/comments

4 parameters

Param	Type	Required	Description
id	integer	required	MaintainX work order id.
cursor	string	optional	MaintainX pagination cursor from a previous response.
limit	integer	optional	Maximum number of records to return.
workOrderId	string	required	Path parameter: workOrderId

POST

maintainx_create_work_order_comment

Create a comment on a MaintainX work order.

/workorders/{workOrderId}/comments

4 parameters

Param	Type	Required	Description
id	integer	required	MaintainX work order id.
content	string	required	Comment content to post.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.
workOrderId	string	required	Path parameter: workOrderId

GET

maintainx_list_locations

List MaintainX locations with filters and cursor pagination.

/locations

7 parameters

Param	Type	Required	Description
cursor	string	optional	MaintainX pagination cursor from a previous response.
limit	integer	optional	Maximum number of records to return.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
organizationIds	array	optional	MaintainX organization ids for endpoints that can query multiple organizations.
name	string	optional	Filter MaintainX locations by name.
customFieldName	array	optional	Custom field names to include.
expand	array	optional	MaintainX location fields to expand.

GET

maintainx_get_location

Retrieve one MaintainX location by id.

/locations/{locationId}

2 parameters

Param	Type	Required	Description
id	integer	optional	MaintainX location id.
locationId	string	required	Path parameter: locationId

POST

maintainx_create_location

Create a MaintainX location.

/locations

9 parameters

Param	Type	Required	Description
name	string	required	MaintainX location name.
description	string	optional	—
address	string	optional	—
barcode	string	optional	—
parentId	integer	optional	—
extraFields	object	optional	MaintainX custom fields keyed by exact custom field labels.
vendorIds	array	optional	Vendor ids assigned to the location.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.

PATCH

maintainx_update_location

Update a MaintainX location.

/locations/{locationId}

10 parameters

Param	Type	Required	Description
id	integer	required	MaintainX location id.
name	string	optional	MaintainX location name.
description	string	optional	—
address	string	optional	—
barcode	string	optional	—
parentId	integer	optional	—
extraFields	object	optional	MaintainX custom fields keyed by exact custom field labels.
vendorIds	array	optional	Vendor ids assigned to the location.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.
locationId	string	required	Path parameter: locationId

DELETE

maintainx_delete_location

Delete a MaintainX location by id.

/locations/{locationId}

3 parameters

Param	Type	Required	Description
id	integer	required	MaintainX location id.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.
locationId	string	required	Path parameter: locationId

GET

maintainx_list_users

List MaintainX users with filters and cursor pagination.

/users

6 parameters

Param	Type	Required	Description
cursor	string	optional	MaintainX pagination cursor from a previous response.
limit	integer	optional	Maximum number of records to return.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
onlyAssignable	boolean	optional	Whether to only return assignable users.
email	array	optional	Email addresses to filter users by.
expand	array	optional	MaintainX user fields to expand.

GET

maintainx_get_user

Retrieve one MaintainX user by id.

/users/{userId}

3 parameters

Param	Type	Required	Description
id	integer	required	MaintainX user id.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
userId	string	required	Path parameter: userId

POST

maintainx_create_user

Create a MaintainX user.

/users

13 parameters

Param	Type	Required	Description
firstName	string	required	MaintainX user's first name.
lastName	string	required	MaintainX user's last name.
email	string	optional	—
phoneNumber	string	optional	—
role	string	optional	—
customRole	string	optional	—
authType	string	optional	—
inviteType	string	optional	—
hourlyRate	integer	optional	—
externalData	object	optional	—
extraFields	object	optional	MaintainX custom fields keyed by exact custom field labels.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.

PATCH

maintainx_update_user

Update a MaintainX user.

/users/{userId}

15 parameters

Param	Type	Required	Description
id	integer	required	MaintainX user id.
firstName	string	optional	MaintainX user's first name.
lastName	string	optional	MaintainX user's last name.
email	string	optional	—
phoneNumber	string	optional	—
role	string	optional	—
customRole	string	optional	—
authType	string	optional	—
inviteType	string	optional	—
hourlyRate	integer	optional	—
externalData	object	optional	—
extraFields	object	optional	MaintainX custom fields keyed by exact custom field labels.
organizationId	integer	optional	MaintainX organization id for multi-organization tokens.
skipWebhook	boolean	optional	Whether MaintainX should skip triggering subscribed webhooks.
userId	string	required	Path parameter: userId