Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/maintainx:maintainx-work-permits-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
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 Work Permits 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: Work Permits
description: Operations for Work Permits
x-traitTag: false
paths:
/workPermits/{id}/sign:
post:
summary: Sign a work permit
parameters:
- schema:
type: integer
name: id
in: path
required: true
description: ID of the id
example: '1'
- schema:
type: boolean
description: Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)
name: skipWebhook
in: query
required: false
requestBody:
description: Sign a work permit
required: true
content:
application/json:
schema:
type: object
required:
- externalLinkUuid
- signerName
properties:
externalLinkUuid:
type: string
example: 2042e4f1-751d-4314-be8a-36a44f32b659
description: Global UUID of the External Link used to sign the Work Permit
signerName:
type: string
example: John Doe
description: Name of the signer when using an External Link
responses:
'201':
description: Successfully signed work permit
content:
application/json:
schema:
type: object
required:
- success
- workPermit
- workOrder
properties:
success:
type: boolean
example: true
workPermit:
type: object
required:
- id
- status
properties:
id:
type: integer
status:
type: string
workOrder:
type: object
required:
- id
- blockedByWorkPermitReason
properties:
id:
type: integer
blockedByWorkPermitReason:
type:
- string
- 'null'
'400':
description: OrganizationId was not provided
content:
application/json:
schema:
type: object
required:
- errors
example:
errors:
- error: Missing x-organization-id header.
properties:
errors:
type: array
items:
type: object
required:
- error
properties:
error:
type: string
fieldPath:
type:
- string
- 'null'
fieldValue:
oneOf:
- type: string
- type: number
- type: boolean
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
description: You are forbidden to perform the requested action, to access this resource or the feature is disabled by your administrator
content:
application/json:
schema:
type: object
required:
- errors
example:
errors:
- error: Forbidden
properties:
errors:
type: array
items:
type: object
required:
- error
properties:
error:
type: string
fieldPath:
type:
- string
- 'null'
fieldValue:
oneOf:
- type: string
- type: number
- type: boolean
security: []
tags:
- Work Permits
operationId: postWorkPermitsByIdSign
x-operation-id-source: derived
components:
responses:
UnauthorizedError:
description: Invalid token
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)