MaintainX Work Request Portals API
Operations on Work Request Portals
OpenAPI Specification
openapi: 3.0.0
info:
description: Welcome to the MaintainX API documentation!<br/><br/>You can use the MaintainX API to programmatically interact with all the entities in MaintainX. Use it to retrieve and manage data of Work Orders, Work Requests, Assets, and more!<br/><br/>To get started, in your MaintainX account go to <a href="https://app.getmaintainx.com/settings/integrations/apiKeys">"Settings > Integrations"</a> and click "+ New Key" button to generate a new Rest API key.<br/><br/><b>Missing something?</b><br/>Don't hesitate to reach out <a href="mailto:support@getmaintainx.com">support@getmaintainx.com</a><br/><br/>
version: '1'
title: MaintainX Asset Criticalities Work Request Portals 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/img/default-org-logo.png
backgroundColor: '#FFFFFF'
altText: MaintainX logo
servers:
- url: https://api.getmaintainx.com/v1
description: Endpoint
security:
- Bearer: []
tags:
- name: Work Request Portals
description: Operations on Work Request Portals
x-traitTag: false
paths:
/workrequestportals:
post:
summary: Create new work request portal
requestBody:
description: Portal to create
required: true
content:
application/json:
schema:
type: object
required:
- title
properties:
title:
type: string
example: Shipping Portal
description: Title of the portal
welcomeText:
type: string
nullable: true
example: Use this portal for all request related to our shipping activities
description: Description text describing the portal
descriptionPlaceholder:
type: string
nullable: true
example: Describe your request
description: Placeholder text for the description field
contactInformation:
type: string
nullable: true
example: Jimmy@example.com
description: Contact of the person creating the portal (email or phone number)
locationId:
type: integer
nullable: true
example: 852
description: ID of the location where the portal is located
assetId:
type: integer
nullable: true
example: 852
description: ID of the asset related to the portal
emailOnly:
type: boolean
example: true
nullable: true
description: Allow request creation with email only to contact the requester
sendEmailNotification:
type: boolean
example: true
nullable: true
description: Send email notifications to the portal requesters with status updates on their requests
responses:
'201':
description: Successfully created portal
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
type: integer
example: 963
description: Global ID of the portal
'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:
nullable: true
type: string
fieldValue:
nullable: true
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:
nullable: true
type: string
fieldValue:
nullable: true
oneOf:
- type: string
- type: number
- type: boolean
tags:
- Work Request Portals
parameters:
- 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
- schema:
type: integer
description: Required if using a multi organizations token
name: x-organization-id
in: header
required: false
example: '1'
get:
summary: List work request portals
description: Endpoint used to list work request portal resources
parameters:
- name: cursor
in: query
schema:
description: Last pagination reference
type: string
- name: limit
in: query
schema:
description: max number of Work Request Portals returned
type: integer
minimum: 1
maximum: 200
default: 100
- schema:
type: integer
description: Required if using a multi organizations token
name: x-organization-id
in: header
required: false
example: '1'
responses:
'200':
description: Successfully fetched Work Request Portals list
content:
application/json:
schema:
type: object
required:
- workRequestPortals
properties:
workRequestPortals:
type: array
items:
type: object
required:
- id
- title
- portalUrl
- welcomeText
- descriptionPlaceholder
- contactInformation
- assetId
- locationId
- emailOnly
- sendEmailNotification
properties:
id:
type: integer
example: 963
description: Global ID of the portal
title:
type: string
example: Shipping Portal
description: Title of the portal
portalUrl:
type: string
example: https://app.getmaintainx.com/request-portal/ae9d33c8-ef78-44c4-925d-352878db0993
description: Url to access the portal
welcomeText:
type: string
nullable: true
example: Use this portal for all request related to our shipping activities
description: Description text describing the portal
descriptionPlaceholder:
type: string
nullable: true
example: Describe your request
description: Placeholder text for the description field
contactInformation:
type: string
nullable: true
example: Jimmy@example.com
description: Contact of the person creating the portal (email or phone number)
assetId:
type: integer
nullable: true
example: 852
description: ID of the asset related to the portal
locationId:
type: integer
nullable: true
example: 852
description: ID of the location where the portal is located
emailOnly:
type: boolean
example: true
nullable: true
description: Allow request creation with email only to contact the requester
sendEmailNotification:
type: boolean
example: true
nullable: true
description: Send email notifications to the portal requesters with status updates on their requests
nextCursor:
description: The cursor to retrieve the next page of Work Request Portals.
type: string
nullable: true
nextPageUrl:
description: Path with query parameters that can be used to retrieve the next page of Work Request Portals.
type: string
nullable: true
'400':
description: Error with query
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
description: Description of error
type: string
'401':
$ref: '#/components/responses/UnauthorizedError'
tags:
- Work Request Portals
/workrequestportals/{id}:
get:
summary: Get work request portal
parameters:
- schema:
type: integer
name: id
in: path
required: true
description: ID of the workRequestPortal
example: '1'
responses:
'200':
description: Successfully retrieved workRequestPortal's information
content:
application/json:
schema:
type: object
required:
- workRequestPortal
properties:
workRequestPortal:
type: object
required:
- id
properties:
id:
type: integer
example: 963
description: Global ID of the portal
title:
type: string
example: Shipping Portal
description: Title of the portal
welcomeText:
type: string
nullable: true
example: Use this portal for all request related to our shipping activities
description: Description text describing the portal
descriptionPlaceholder:
type: string
nullable: true
example: Describe your request
description: Placeholder text for the description field
contactInformation:
type: string
nullable: true
example: Jimmy@example.com
description: Contact of the person creating the portal (email or phone number)
portalUrl:
type: string
example: https://app.getmaintainx.com/request-portal/ae9d33c8-ef78-44c4-925d-352878db0993
description: Url to access the portal
locationId:
type: integer
nullable: true
example: 852
description: ID of the location where the portal is located
assetId:
type: integer
nullable: true
example: 852
description: ID of the asset related to the portal
emailOnly:
type: boolean
example: true
nullable: true
description: Allow request creation with email only to contact the requester
sendEmailNotification:
type: boolean
example: true
nullable: true
description: Send email notifications to the portal requesters with status updates on their requests
'400':
description: Error with query
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
description: Description of error
type: string
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Could not find the specified workRequestPortal or the user cannot access it.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: string
example: Not Found.
tags:
- Work Request Portals
patch:
summary: Update work request portal
parameters:
- schema:
type: integer
name: id
in: path
required: true
description: ID of the work request portal
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: Work request portal to update
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
example: Shipping Portal
description: Title of the portal
welcomeText:
type: string
nullable: true
example: Use this portal for all request related to our shipping activities
description: Description text describing the portal
descriptionPlaceholder:
type: string
nullable: true
example: Describe your request
description: Placeholder text for the description field
contactInformation:
type: string
nullable: true
example: Jimmy@example.com
description: Contact of the person creating the portal (email or phone number)
locationId:
type: integer
nullable: true
example: 852
description: ID of the location where the portal is located
assetId:
type: integer
nullable: true
example: 852
description: ID of the asset related to the portal
emailOnly:
type: boolean
example: true
nullable: true
description: Allow request creation with email only to contact the requester
sendEmailNotification:
type: boolean
example: true
nullable: true
description: Send email notifications to the portal requesters with status updates on their requests
responses:
'200':
description: Successfully edited work request portal
content:
application/json:
schema:
type: object
required:
- workRequestPortal
properties:
workRequestPortal:
type: object
required:
- id
- title
properties:
id:
type: integer
example: 963
description: Global ID of the portal
title:
type: string
example: Shipping Portal
description: Title of the portal
welcomeText:
type: string
nullable: true
example: Use this portal for all request related to our shipping activities
description: Description text describing the portal
descriptionPlaceholder:
type: string
nullable: true
example: Describe your request
description: Placeholder text for the description field
contactInformation:
type: string
nullable: true
example: Jimmy@example.com
description: Contact of the person creating the portal (email or phone number)
portalUrl:
type: string
example: https://app.getmaintainx.com/request-portal/ae9d33c8-ef78-44c4-925d-352878db0993
description: Url to access the portal
locationId:
type: integer
nullable: true
example: 852
description: ID of the location where the portal is located
assetId:
type: integer
nullable: true
example: 852
description: ID of the asset related to the portal
emailOnly:
type: boolean
example: true
nullable: true
description: Allow request creation with email only to contact the requester
sendEmailNotification:
type: boolean
example: true
nullable: true
description: Send email notifications to the portal requesters with status updates on their requests
'400':
description: Failed to edit the work request portal
content:
application/json:
schema:
type: object
required:
- errors
example:
errors:
- error: parentId is not valid
properties:
errors:
type: array
items:
type: object
required:
- error
properties:
error:
type: string
fieldPath:
nullable: true
type: string
fieldValue:
nullable: true
oneOf:
- type: string
- type: number
- type: boolean
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Could not find the specified work request portal.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: string
example: work request portal Not Found
tags:
- Work Request Portals
delete:
summary: Delete work request portal
parameters:
- schema:
type: integer
name: id
in: path
required: true
description: ID of the workRequestPortal
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
responses:
'204':
description: Successfully deleted the workRequestPortal
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Could not find the specified workRequestPortal.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: string
example: workRequestPortal Not Found
'500':
description: Internal server error.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: string
example: Internal server error.
tags:
- Work Request Portals
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-webhooks:
API_TOKEN_CREATED:
post:
summary: API Token Created
security: []
description: Fires when a REST API token is generated.
tags:
- Subscriptions & Webhooks
requestBody:
content:
application/json:
schema:
type: object
required:
- orgId
- actorId
- occurredAt
properties:
orgId:
type: number
description: Global ID of the organization
example: 321
actorId:
type: number
description: User ID of the actor who triggered the event
example: 100
occurredAt:
type: string
format: date-time
description: Date & time at which the event occurred
example: '2022-01-01T00:00:00.000Z'
operationId: API_TOKEN_CREATED
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
API_TOKEN_REVOKED:
post:
summary: API Token Revoked
security: []
description: Fires when a REST API token is revoked.
tags:
- Subscriptions & Webhooks
requestBody:
content:
application/json:
schema:
type: object
required:
- orgId
- actorId
- occurredAt
properties:
orgId:
type: number
description: Global ID of the organization
example: 321
actorId:
type: number
description: User ID of the actor who triggered the event
example: 100
occurredAt:
type: string
format: date-time
description: Date & time at which the event occurred
example: '2022-01-01T00:00:00.000Z'
operationId: API_TOKEN_REVOKED
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
ASSET_STATUS_CHANGE:
post:
summary: Asset Status Change
security: []
description: ''
tags:
- Subscriptions & Webhooks
requestBody:
content:
application/json:
schema:
type: object
required:
- assetId
- orgId
- oldStatus
- newStatus
- occurredAt
properties:
assetId:
type: number
description: Global ID of the asset
example: 42
orgId:
type: number
description: Global ID of the organization
example: 21
oldStatus:
description: Previous status of the asset
type: object
properties:
id:
type: number
example: 42
description: Global ID of the asset status.
customStatus:
type: object
required:
- label
properties:
id:
type: number
example: Global ID of the custom asset status.
label:
type: string
example: Decommissioned
createdAt:
type: string
format: date-time
description: Date & time at which the asset custom status was created.
example: '2022-01-01T12:34:56.123Z'
updatedAt:
type: string
format: date-time
description: Date & time at which the asset custom status was last updated.
example: '2022-01-01T12:34:56.123Z'
deletedAt:
type: string
nullable: true
description: Date at which the asset custom status was deleted.
format: date-time
example: '2022-01-01T12:34:56.123Z'
downtimeType:
type: string
nullable: true
example: null
enum:
- PLANNED
- UNPLANNED
deprecated: true
description: Downtime type on asset custom statuses will always return null. Use downtime type on asset status instead.
description: Custom status assigned to asset.
nullable: true
customStatusId:
type: number
description: Id of the custom status assigned to asset.
nullable: true
example: 53
status:
type: string
example: OFFLINE
description: Asset status value.
enum:
- IGNORE
- OFFLINE
- ONLINE
downtimeType:
type: string
nullable: true
example: PLANNED
enum:
- PLANNED
- UNPLANNED
startedAt:
type: string
format: date-time
example: '2022-01-01T12:34:56.123Z'
description: Asset status effective start date.
endedAt:
type: string
format: date-time
example: '2022-01-01T12:34:56.123Z'
description: Asset status effective end date.
nullable: true
description:
type: string
example: Overheated - needs servicing.
nullable: true
createdAt:
type: string
format: date-time
example: '2022-01-01T12:34:56.123Z'
readOnly: true
description: Date & time at which the asset status was created.
updatedAt:
type: string
format: date-time
example: '2022-01-01T12:34:56.123Z'
readOnly: true
description: Date & time at which the asset status was last updated.
deletedAt:
type: string
format: date-time
example: '2022-01-01T12:34:56.123Z'
readOnly: true
description: Date & time at which the asset status was deleted.
nullable: true
example:
status: ONLINE
startedAt: '2022-01-01T12:34:56.123Z'
endedAt: '2022-01-01T12:34:56.123Z'
description: Back online after scheduled maintenance
createdAt: '2022-01-01T12:34:56.123Z'
updatedAt: '2022-01-01T12:34:56.123Z'
deletedAt: '2022-01-01T12:34:56.123Z'
newStatus:
description: New status of the asset
type: object
properties:
id:
type: number
example: 42
description: Global ID of the asset status.
customStatus:
type: object
required:
- label
properties:
id:
type: number
example: Global ID of the custom asset status.
label:
type: string
example: Decommissioned
createdAt:
type: string
# --- truncated at 32 KB (204 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/maintainx/refs/heads/main/openapi/maintainx-work-request-portals-api-openapi.yml