Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
description: 'REST API V1
Support: support@getmaintainx.com | https://www.getmaintainx.com/
This is the MaintainX REST API reference. It provides detailed documentation for endpoints, request parameters, response schemas, and error codes available.
For setup guides, authentication walkthroughs, how-tos, etc., see the Build With MaintainX guide.
What''s in this reference:
Full endpoint listings across all MaintainX entities (Work Orders, Assets, Parts, Locations, Users, and more)
Request and response schemas with field-level detail
Query parameters, filters, and pagination behavior
Authentication requirements and error codes
Subscriptions and webhooks for event-driven integrations
Base URL: https://api.getmaintainx.com/v1
All requests must be authenticated with a Bearer token (see Settings > Integrations > API Keys to generate a key).
API access is available on Premium and Enterprise plans.'
version: '1'
title: MaintainX OpenAPI Documentation API
contact:
url: https://www.getmaintainx.com/
name: Support
email: support@getmaintainx.com
x-logo:
url: https://maintainx-static.s3.us-west-2.amazonaws.com/logo/adsk-maintainx-logo.svg
backgroundColor: '#FFFFFF'
altText: MaintainX, an Autodesk company
servers:
- url: https://api.getmaintainx.com/v1
description: Endpoint
security:
- Bearer: []
tags:
- name: OpenAPI Documentation
description: OpenAPI Specification Documentation
x-traitTag: false
paths:
/versions:
get:
summary: Get list of available API versions
responses:
'200':
description: Successfully retrieved list of available versions
content:
application/json:
schema:
type: array
items:
type: object
required:
- version
properties:
version:
type: string
example: '1'
security: []
tags:
- OpenAPI Documentation
servers:
- url: https://api.getmaintainx.com
description: Endpoint
operationId: getVersions
x-operation-id-source: derived
components:
securitySchemes:
Bearer:
description: "\n <p>Authenticate by adding the following HTTP header to your requests:</p>\n<pre>Authorization: bearer {{token}}</pre>\n<p>The <code>token</code> can be generated in your MaintainX account. Go to <a href=\"https://app.getmaintainx.com/settings/integrations/apiKeys\">\"Settings > Integrations > API Keys\"</a> to generate a key for your user.</p>\n"
type: http
scheme: bearer
bearerFormat: JWT
x-provenance:
method: harvested
publisher: MaintainX
source: https://api.getmaintainx.com/v1/openapi.json?v=26.10.1451-310524
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)