Skip to main content

MaintainX

MaintainX is a cloud-based CMMS (computerized maintenance management system) for managing work orders, assets, locations, inventory parts, purchase orders, and maintenance teams. Its REST API exposes these records so you can move maintenance data in and out of MaintainX programmatically.

MaintainX icon

Power end-to-end data operations for your MaintainX API with Nexla. Our bi-directional MaintainX connector is purpose-built for MaintainX, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to MaintainX or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your MaintainX workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a MaintainX credential, you need a MaintainX REST API key. MaintainX authenticates every request with a Bearer token sent in the Authorization header (Authorization: bearer <token>).

To obtain your API key, follow these steps:

  1. Sign in to your MaintainX account with a user that has permission to manage integrations.

  2. Navigate to Settings > Integrations > API Keys.

  3. Click + New Key to generate a new REST API key for your account, and copy the generated key. Store it securely, as it grants access to your MaintainX data.

  4. If your token has access to more than one MaintainX organization, note the Organization ID you want Nexla to scope requests to. This is only needed for multi-organization accounts; single-organization accounts can leave it blank.

For detailed information about authentication, available resources, and request formats, see the MaintainX REST API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API TokenYesYesMaintainX REST API key generated under Settings > Integrations > API Keys in your MaintainX account.
Organization ID (multi-org accounts only)NoNoRequired only for multi-organization MaintainX accounts. Sent as the x-organization-id header to scope list/create requests. Leave blank for single-org accounts.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your MaintainX REST API key in the API Token field. This token is sent as Authorization: bearer <token> on every request to the MaintainX API and must be kept confidential.

  4. If your account spans multiple organizations, enter the Organization ID (multi-org accounts only) to scope requests to that organization. Leave this field blank for single-organization accounts.

    If your API key is compromised, revoke it under Settings > Integrations > API Keys in MaintainX and generate a new one. The API key grants access to your MaintainX data and should be treated as sensitive information.

    For detailed information about authentication, available resources, and request formats, see the MaintainX REST API documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the MaintainX connector tile, then select the credential that will be used to connect to the MaintainX instance, and click Next; or, create a new MaintainX credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common MaintainX endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Work Orders

List work orders with optional filters (status, assignee, dates, etc).

[Rest API] Get Work Order

Get a single work order by ID.

[Rest API] List Assets

List assets (equipment) with optional filters.

[Rest API] Get Asset

Get a single asset by ID.

[Rest API] List Locations

List locations.

[Rest API] Get Location

Get a single location by ID.

[Rest API] List Users

List users in the organization.

[Rest API] Get User

Get a single user by ID.

[Rest API] List Teams

List teams in the organization.

[Rest API] Get Team

Get a single team by ID.

[Rest API] List Parts

List inventory parts.

[Rest API] Get Part

Get a single part by ID.

[Rest API] List Procedure Templates

List procedure templates.

[Rest API] Get Procedure Template

Get a single procedure template by ID.

[Rest API] List Suppliers

List vendor/supplier records (external suppliers in MaintainX, not the Nexla connector vendor).

[Rest API] Get Supplier

Get a single vendor/supplier record by ID.

[Rest API] List Purchase Orders

List purchase orders.

[Rest API] Get Purchase Order

Get a single purchase order by ID.

[Rest API] List Work Requests

List work requests (pre-work-order submissions).

[Rest API] Get Work Request

Get a single work request by ID.

[Rest API] List Meters

List meters used for meter-based maintenance triggers.

[Rest API] Get Meter

Get a single meter by ID.

[Rest API] List Categories

List work order/asset categories.

[Rest API] List Asset Statuses

List available asset statuses.

[Rest API] List Meter Triggers

List meter-based maintenance triggers.

[Rest API] List Manufacturers

List asset manufacturers.

[Rest API] List Organizations

List organizations accessible to the API key.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

MaintainX data sources can also be manually configured to ingest data from any valid MaintainX REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new MaintainX data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the MaintainX destination, and select the Send to Destination option from the menu. Select the MaintainX connector from the list of available destination connectors, then select the credential that will be used to connect to the MaintainX organization, and click Next; or, create a new MaintainX credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common MaintainX endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Work Order

Create a new work order.

[Rest API] Update Work Order

Update an existing work order.

[Rest API] Update Work Order Status

Update the status of a work order (OPEN, IN_PROGRESS, ON_HOLD, DONE, CANCELED).

[Rest API] Create Asset

Create a new asset.

[Rest API] Update Asset

Update an existing asset.

[Rest API] Create Location

Create a new location.

[Rest API] Update Location

Update an existing location.

[Rest API] Create Part

Create a new inventory part.

[Rest API] Update Part

Update an existing part.

[Rest API] Create Purchase Order

Create a new purchase order.

[Rest API] Update Purchase Order

Update an existing purchase order.

[Rest API] Create Work Request

Create a new work request.

[Rest API] Create Supplier

Create a new vendor/supplier record.

[Rest API] Create User

Create a new user in the organization.

Manual configuration

MaintainX destinations can also be manually configured to send data to any valid MaintainX REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

MaintainX APIs expect JSON format for create and update operations. For update operations, include the ID of the record to be updated in the request path.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured MaintainX endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the MaintainX endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.