maintainx-work-orders

Server path: /maintainx-work-orders | Type: Application | PCID required: Yes

Tools

Tool	Description
`maintainx_work_orders_create_workorders`	Create new work order
`maintainx_work_orders_create_workorders_comments`	Create new comment on a work order
`maintainx_work_orders_create_workorders_costs`	Create new cost on a work order
`maintainx_work_orders_create_workorders_emails`	Send work order as an email
`maintainx_work_orders_create_workpermits_sign`	Sign a work permit
`maintainx_work_orders_create_workrequestportals`	Create new work request portal
`maintainx_work_orders_create_workrequests`	Create work request
`maintainx_work_orders_delete_workorders`	Delete workOrder
`maintainx_work_orders_delete_workorders_attachments`	Remove work order attachment
`maintainx_work_orders_delete_workorders_procedure`	Detach procedure from work order
`maintainx_work_orders_delete_workorders_procedure_fields_attachment`	Delete procedure field attachment
`maintainx_work_orders_delete_workrequestportals`	Delete work request portal
`maintainx_work_orders_delete_workrequests`	Delete workRequest
`maintainx_work_orders_delete_workrequests_attachments`	Remove work request attachment
`maintainx_work_orders_get_workorders`	Get work order
`maintainx_work_orders_get_workorders_comments`	List work order comments
`maintainx_work_orders_get_workorders_costs`	Get costs information
`maintainx_work_orders_get_workorders_subworkorders`	List sub work orders
`maintainx_work_orders_get_workrequestportals`	Get work request portal
`maintainx_work_orders_get_workrequests`	Get work request
`maintainx_work_orders_list_workorders`	List work orders
`maintainx_work_orders_list_workorders_comments`	List work order comments
`maintainx_work_orders_list_workorders_subworkorders`	List sub work orders
`maintainx_work_orders_list_workrequestportals`	List work request portals
`maintainx_work_orders_list_workrequests`	List work requests
`maintainx_work_orders_update_workorders`	Update work order
`maintainx_work_orders_update_workorders_procedure_fields_attachment`	Update procedure field attachment
`maintainx_work_orders_update_workorders_status`	Update work order status
`maintainx_work_orders_update_workrequestportals`	Update work request portal
`maintainx_work_orders_update_workrequests`	Update work request
`maintainx_work_orders_upload_workorders_attachments`	Update work order attachment
`maintainx_work_orders_upload_workorders_thumbnail`	Update work order’s thumbnail
`maintainx_work_orders_upload_workrequests_attachments`	Update work request attachment
`maintainx_work_orders_upload_workrequests_thumbnail`	Update work request’s thumbnail

maintainx_work_orders_create_workorders

Create new work order Parameters:

Parameter	Type	Required	Default	Description
`skipWebhook`	boolean	No	—	Set skipWebhook=true to skip all webhooks upon successful work order creation.
`x-organization-id`	integer	No	—	Required if using a multi organizations token
`assetId`	integer	No	—	Asset Id
`assignees`	object[]	No	—	Either the teamId, the userId or the user email address
`categories`	string[]	No	—	List of categories that identify the work order
`description`	string	No	—	The description value
`dueDate`	string	No	—	Date & time at which the work order is due
`estimatedTime`	integer	No	—	The estimated time taken in seconds to complete the work order
`externalData`	object	No	—	Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
`extraFields`	object	No	—	Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Estimated Time Allotted”)
`isParent`	boolean	No	—	Whether the work order is a parent work order. A parent work order has only a subset of the standard work order fields. It also has fields that aren’t included in a standard work order. <a href=‘https://help.getmaintainx.com/multi-asset-work-orders?utm_source=mx-api-docs&utm_medium=web&utm_campaign=multi-asset-work-orders&utm_id=maintainx’ target=’_blank’>Learn more</a></br>Mutually exclusive with parentId
`locationId`	integer	No	—	Global ID of the location assigned to the work order
`parentId`	number	No	—	ID of the parent work order. If provided, the work order will be created as a sub-work order under this parent work order. Sub-work orders inherit most of their fields from the parent work order. <a href=‘https://help.getmaintainx.com/create-and-manage-sub-work-orders?utm_source=mx-api-docs&utm_medium=web&utm_campaign=create-and-manage-sub-work-orders&utm_id=maintainx’ target=’_blank’>Learn more</a></br>Mutually exclusive with isParent
`partsUsed`	object[]	No	—	Parts IDs and quantities used in this work order
`priority`	string	No	—	The priority value
`procedure`	object	No	—	The procedure value
`procedureTemplateId`	number	No	—	ID of the procedure template to attach
`repeatability`	object	No	—	The repeatability value
`requesterId`	object	No	—	ID or email of the user who requested the work order
`skipRestHook`	boolean	No	—	When work order is created, will not trigger any rest hook that is subscribed
`startDate`	string	No	—	Date & time at which the work order will show up in the inbox</br>Only valid when <b>dueDate</b> is set
`title`	string	Yes	—	The title value
`type`	string	No	—	Valid types of Work Orders.
`vendorIds`	number[]	No	—	Vendor IDs
`workOrderTemplateId`	integer	No	—	ID of the Work Order Template that will be used to create this work order. Note that data from the payload will overwrite the Template data. Also, restrictions defined by the Template (EG: Required/Hidden/Read-Only fields) will apply.
`workRequestId`	integer	No	—	ID of the Work Request that will be approved by the creation of this work order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "skipWebhook": {
      "type": "boolean",
      "description": "Set skipWebhook=true to skip all webhooks upon successful work order creation."
    },
    "x-organization-id": {
      "type": "integer",
      "description": "Required if using a multi organizations token"
    },
    "assetId": {
      "type": "integer",
      "description": "Asset Id"
    },
    "assignees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "USER",
              "TEAM"
            ],
            "description": "The type value"
          },
          "id": {
            "description": "The id value"
          }
        },
        "required": [
          "type",
          "id"
        ]
      },
      "description": "Either the teamId, the userId or the user email address"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of categories that identify the work order"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "dueDate": {
      "type": "string",
      "description": "Date & time at which the work order is due"
    },
    "estimatedTime": {
      "type": "integer",
      "description": "The estimated time taken in seconds to complete the work order"
    },
    "externalData": {
      "description": "Extra data that can be attached to the work order, for example to help reference to a matching record in an external system."
    },
    "extraFields": {
      "type": "object",
      "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"Estimated Time Allotted\")"
    },
    "isParent": {
      "type": "boolean",
      "description": "Whether the work order is a parent work order. A parent work order has only a subset of the standard work order fields. It also has fields that aren't included in a standard work order. <a href='https://help.getmaintainx.com/multi-asset-work-orders?utm_source=mx-api-docs&utm_medium=web&utm_campaign=multi-asset-work-orders&utm_id=maintainx' target='_blank'>Learn more</a></br>Mutually exclusive with **parentId**"
    },
    "locationId": {
      "type": "integer",
      "description": "Global ID of the location assigned to the work order"
    },
    "parentId": {
      "type": "number",
      "description": "ID of the parent work order. If provided, the work order will be created as a sub-work order under this parent work order. Sub-work orders inherit most of their fields from the parent work order. <a href='https://help.getmaintainx.com/create-and-manage-sub-work-orders?utm_source=mx-api-docs&utm_medium=web&utm_campaign=create-and-manage-sub-work-orders&utm_id=maintainx' target='_blank'>Learn more</a></br>Mutually exclusive with **isParent**"
    },
    "partsUsed": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "partId": {
            "type": "integer",
            "description": "Global ID of the part"
          },
          "quantityUsed": {
            "type": "integer",
            "description": "Quantity used in the work order."
          },
          "locationId": {
            "type": "integer",
            "description": "Global ID of the location of the part"
          },
          "copyOnRecurring": {
            "type": "string",
            "enum": [
              "NoCopy",
              "Copy",
              "Default"
            ],
            "description": "Indicates if the parts will be copied to the next work order in the chain (if applicable)."
          }
        },
        "required": [
          "partId",
          "quantityUsed"
        ]
      },
      "description": "Parts IDs and quantities used in this work order"
    },
    "priority": {
      "type": "string",
      "description": "The priority value",
      "enum": [
        "NONE",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "procedure": {
      "type": "object",
      "description": "The procedure value",
      "properties": {
        "id": {
          "type": "number",
          "description": "You should favor 'procedureTemplateId' to attach a procedure template."
        },
        "title": {
          "type": "string",
          "description": "Title of the procedure"
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Steps of a procedure"
        }
      },
      "required": [
        "title",
        "fields"
      ]
    },
    "procedureTemplateId": {
      "type": "number",
      "description": "ID of the procedure template to attach"
    },
    "repeatability": {
      "type": "object",
      "description": "The repeatability value"
    },
    "requesterId": {
      "description": "ID or email of the user who requested the work order"
    },
    "skipRestHook": {
      "type": "boolean",
      "description": "When work order is created, will not trigger any rest hook that is subscribed"
    },
    "startDate": {
      "type": "string",
      "description": "Date & time at which the work order will show up in the inbox</br>Only valid when <b>dueDate</b> is set"
    },
    "title": {
      "type": "string",
      "description": "The title value"
    },
    "type": {
      "type": "string",
      "description": "Valid types of Work Orders.",
      "enum": [
        "OTHER",
        "REACTIVE",
        "PREVENTIVE"
      ]
    },
    "vendorIds": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Vendor IDs"
    },
    "workOrderTemplateId": {
      "type": "integer",
      "description": "ID of the Work Order Template that will be used to create this work order. Note that data from the payload will overwrite the Template data. Also, restrictions defined by the Template (EG: Required/Hidden/Read-Only fields) will apply."
    },
    "workRequestId": {
      "type": "integer",
      "description": "ID of the Work Request that will be approved by the creation of this work order"
    }
  },
  "required": [
    "PCID",
    "title"
  ]
}

maintainx_work_orders_create_workorders_comments

Create new comment on a work order Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Global ID of the work order
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`content`	string	Yes	—	Content of the comment to post

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Global ID of the work order"
    },
    "skipWebhook": {
      "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)"
    },
    "content": {
      "type": "string",
      "description": "Content of the comment to post"
    }
  },
  "required": [
    "PCID",
    "id",
    "content"
  ]
}

maintainx_work_orders_create_workorders_costs

Create new cost on a work order Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Global ID of the work order
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`body`	object	Yes	—	Cost to create

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Global ID of the work order"
    },
    "skipWebhook": {
      "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)"
    },
    "body": {
      "type": "object",
      "description": "Cost to create"
    }
  },
  "required": [
    "PCID",
    "id",
    "body"
  ]
}

maintainx_work_orders_create_workorders_emails

Send work order as an email Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Global ID of the work order
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`customMessage`	string	No	—	Custom message to send with the Work Order
`emails`	string[]	No	—	Emails to send the Work Order to
`exportOptions`	object	No	—	Type of export options for the work order attached to the email

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Global ID of the work order"
    },
    "skipWebhook": {
      "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)"
    },
    "customMessage": {
      "type": "string",
      "description": "Custom message to send with the Work Order"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Emails to send the Work Order to"
    },
    "exportOptions": {
      "type": "object",
      "description": "Type of export options for the work order attached to the email",
      "properties": {
        "attachments": {
          "type": "boolean",
          "description": "Include attachments"
        },
        "comments": {
          "type": "boolean",
          "description": "Include comments"
        },
        "costs": {
          "type": "string",
          "description": "Include cost-related information",
          "enum": [
            "DETAILED",
            "NONE",
            "SUMMARY"
          ]
        },
        "history": {
          "type": "boolean",
          "description": "Include work order history"
        },
        "procedureFormat": {
          "type": "string",
          "description": "Include procedure format",
          "enum": [
            "DETAILED",
            "FLAGS_FAILS",
            "NONE",
            "SUMMARY"
          ]
        },
        "images": {
          "type": "string",
          "description": "Include images",
          "enum": [
            "FULL_SIZE",
            "ORIGINAL_SIZE",
            "REGULAR_SIZE",
            "SHOW_AS_FILE",
            "THUMBNAIL_SIZE"
          ]
        },
        "includeBasicInformation": {
          "type": "boolean",
          "description": "Include basic information"
        },
        "includeExportInformation": {
          "type": "boolean",
          "description": "Include export information"
        },
        "includeLocationAddress": {
          "type": "boolean",
          "description": "Include location address"
        },
        "includedCustomFields": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Include custom fields"
        },
        "priority": {
          "type": "boolean",
          "description": "Include priority information"
        },
        "qrCode": {
          "type": "boolean",
          "description": "Include QR code"
        },
        "signatureBox": {
          "type": "boolean",
          "description": "Include signature box"
        },
        "vendorInformation": {
          "type": "boolean",
          "description": "Include vendor information"
        },
        "vendors": {
          "type": "boolean",
          "description": "Include vendors"
        },
        "workOrderInfo": {
          "type": "boolean",
          "description": "Include work order information"
        }
      }
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_create_workpermits_sign

Sign a work permit Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the id
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`externalLinkUuid`	string	Yes	—	Global UUID of the External Link used to sign the Work Permit
`signerName`	string	Yes	—	Name of the signer when using an External Link

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the id"
    },
    "skipWebhook": {
      "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)"
    },
    "externalLinkUuid": {
      "type": "string",
      "description": "Global UUID of the External Link used to sign the Work Permit"
    },
    "signerName": {
      "type": "string",
      "description": "Name of the signer when using an External Link"
    }
  },
  "required": [
    "PCID",
    "id",
    "externalLinkUuid",
    "signerName"
  ]
}

maintainx_work_orders_create_workrequestportals

Create new work request portal Parameters:

Parameter	Type	Required	Default	Description
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`x-organization-id`	integer	No	—	Required if using a multi organizations token
`assetId`	integer	No	—	ID of the asset related to the portal
`contactInformation`	string	No	—	Contact of the person creating the portal (email or phone number)
`descriptionPlaceholder`	string	No	—	Placeholder text for the description field
`emailOnly`	boolean	No	—	Allow request creation with email only to contact the requester
`locationId`	integer	No	—	ID of the location where the portal is located
`sendEmailNotification`	boolean	No	—	Send email notifications to the portal requesters with status updates on their requests
`title`	string	Yes	—	Title of the portal
`welcomeText`	string	No	—	Description text describing the portal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "skipWebhook": {
      "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)"
    },
    "x-organization-id": {
      "type": "integer",
      "description": "Required if using a multi organizations token"
    },
    "assetId": {
      "type": "integer",
      "description": "ID of the asset related to the portal"
    },
    "contactInformation": {
      "type": "string",
      "description": "Contact of the person creating the portal (email or phone number)"
    },
    "descriptionPlaceholder": {
      "type": "string",
      "description": "Placeholder text for the description field"
    },
    "emailOnly": {
      "type": "boolean",
      "description": "Allow request creation with email only to contact the requester"
    },
    "locationId": {
      "type": "integer",
      "description": "ID of the location where the portal is located"
    },
    "sendEmailNotification": {
      "type": "boolean",
      "description": "Send email notifications to the portal requesters with status updates on their requests"
    },
    "title": {
      "type": "string",
      "description": "Title of the portal"
    },
    "welcomeText": {
      "type": "string",
      "description": "Description text describing the portal"
    }
  },
  "required": [
    "PCID",
    "title"
  ]
}

maintainx_work_orders_create_workrequests

Create work request Parameters:

Parameter	Type	Required	Default	Description
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`x-organization-id`	integer	No	—	Required if using a multi organizations token
`approverTeamId`	number	No	—	ID of the team that is reponsible for approving the request.
`assetId`	number	No	—	Asset Id
`creatorContactInfo`	string	No	—	The creator’s contact information associated with this work order request. Possible types are `EMAIL`, `PHONE`, and `OTHER`, which will be inferred from the string provided
`description`	string	No	—	The description value
`extraFields`	object	No	—	Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Request Type”)
`locationId`	number	No	—	Location Id
`priority`	string	No	—	The priority value
`title`	string	Yes	—	The title value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "skipWebhook": {
      "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)"
    },
    "x-organization-id": {
      "type": "integer",
      "description": "Required if using a multi organizations token"
    },
    "approverTeamId": {
      "type": "number",
      "description": "ID of the team that is reponsible for approving the request."
    },
    "assetId": {
      "type": "number",
      "description": "Asset Id"
    },
    "creatorContactInfo": {
      "type": "string",
      "description": "The creator's contact information associated with this work order request. Possible types are `EMAIL`, `PHONE`, and `OTHER`, which will be inferred from the string provided"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "extraFields": {
      "type": "object",
      "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"Request Type\")"
    },
    "locationId": {
      "type": "number",
      "description": "Location Id"
    },
    "priority": {
      "type": "string",
      "description": "The priority value",
      "enum": [
        "NONE",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "title": {
      "type": "string",
      "description": "The title value"
    }
  },
  "required": [
    "PCID",
    "title"
  ]
}

maintainx_work_orders_delete_workorders

Delete workOrder Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workOrder
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workOrder"
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_delete_workorders_attachments

Remove work order attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order.
`filename`	string	Yes	—	Name of the attachment, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order."
    },
    "filename": {
      "type": "string",
      "description": "Name of the attachment, including the extension."
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id",
    "filename"
  ]
}

maintainx_work_orders_delete_workorders_procedure

Detach procedure from work order Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_delete_workorders_procedure_fields_attachment

Delete procedure field attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order
`index`	integer	Yes	—	Sequential index of the field in the procedure
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    },
    "index": {
      "type": "integer",
      "description": "Sequential index of the field in the procedure"
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id",
    "index"
  ]
}

maintainx_work_orders_delete_workrequestportals

Delete work request portal Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workRequestPortal
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workRequestPortal"
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_delete_workrequests

Delete workRequest Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workRequest
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workRequest"
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_delete_workrequests_attachments

Remove work request attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work request.
`filename`	string	Yes	—	Name of the attachment, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work request."
    },
    "filename": {
      "type": "string",
      "description": "Name of the attachment, including the extension."
    },
    "skipWebhook": {
      "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)"
    }
  },
  "required": [
    "PCID",
    "id",
    "filename"
  ]
}

maintainx_work_orders_get_workorders

Get work order Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workOrder
`expand`	string[]	No	—	To expand multiple fields: `expand=assignees&expand=asset`
`useSequentialId`	boolean	No	—	Whether to use the sequential ID instead of the global ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workOrder"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "assignees",
          "asset",
          "estimated_time",
          "location",
          "parts",
          "times",
          "time_items",
          "expenditures",
          "extra_fields"
        ]
      },
      "description": "To expand multiple fields: `expand=assignees&expand=asset`"
    },
    "useSequentialId": {
      "type": "boolean",
      "description": "Whether to use the sequential ID instead of the global ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_get_workorders_comments

List work order comments Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Global ID of the work order
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Comments returned

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Global ID of the work order"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Comments returned"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_get_workorders_costs

Get costs information Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_get_workorders_subworkorders

List sub work orders Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	Global ID of the work order
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Subworkorders returned
`expand`	string[]	No	—	To expand multiple fields: `expand=assignees&expand=asset`

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "Global ID of the work order"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Subworkorders returned"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "assignees",
          "asset",
          "categories",
          "estimated_time",
          "location",
          "parts",
          "procedure",
          "times",
          "time_items",
          "expenditures",
          "extra_fields"
        ]
      },
      "description": "To expand multiple fields: `expand=assignees&expand=asset`"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_get_workrequestportals

Get work request portal Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workRequestPortal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workRequestPortal"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_get_workrequests

Get work request Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workRequest
`expand`	string[]	No	—	To expand multiple fields: `expand=asset&expand=location`

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workRequest"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "asset",
          "location",
          "work_order",
          "extra_fields"
        ]
      },
      "description": "To expand multiple fields: `expand=asset&expand=location`"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_list_workorders

List work orders Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Work Orders returned
`title`	string	No	—	To filter work orders by title
`assets`	integer[]	No	—	To filter by multiple asset IDs: `assets=630&assets=634`
`notAssets`	integer[]	No	—	Filter work orders that have none of the provided assets. To filter by multiple asset IDs: `notAssets=630&notAssets=634`
`locations`	integer[]	No	—	To filter by multiple location IDs: `locations=193&locations=194&locations=195`
`notLocations`	integer[]	No	—	Filter work orders that have none of the provided locations. To filter by multiple location IDs: `notLocations=193&notLocations=194&notLocations=195`
`parts`	integer[]	No	—	To filter by multiple part IDs: `parts=14677&parts=14687`
`notParts`	integer[]	No	—	Filter work orders that have none of the provided parts. To filter by multiple part IDs: `notParts=14677&notParts=14687`
`vendors`	integer[]	No	—	To filter by multiple vendor IDs: `vendors=7123&vendors=2234`
`notVendors`	integer[]	No	—	Filter work orders that have none of the provided vendors. To filter by multiple vendor IDs: `notVendors=7123&notVendors=2234`
`assignees`	integer[]	No	—	To filter by multiple assignee IDs: `assignees=23494&assignees=79808`
`teams`	integer[]	No	—	To filter by multiple team IDs: `teams=112&teams=243`
`categories`	any[]	No	—	To filter by multiple categories: `categories=123456&categories=Damage`
`notCategories`	any[]	No	—	Filter work orders that have none of the provided categories. To filter by multiple categories: `notCategories=123456&notCategories=Damage`
`priorities`	string[]	No	—	To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`
`statuses`	string[]	No	—	To filter by multiple statuses: `statuses=IN_PROGRESS&statuses=DONE`
`show_upcoming`	boolean	No	—	Include work orders with a future start date
`sort`	string	No	—	Attribute on which to sort the list. (for descending order, prefix attribute with ’-’).
`expand`	string[]	No	—	To expand multiple fields: `expand=thumbnail&expand=assignees`
`x-organization-id`	integer	No	—	Required if using a multi organizations token

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Work Orders returned"
    },
    "title": {
      "type": "string",
      "description": "To filter work orders by title"
    },
    "assets": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple asset IDs: `assets=630&assets=634`"
    },
    "notAssets": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Filter work orders that have none of the provided assets. To filter by multiple asset IDs: `notAssets=630&notAssets=634`"
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple location IDs: `locations=193&locations=194&locations=195`"
    },
    "notLocations": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Filter work orders that have none of the provided locations. To filter by multiple location IDs: `notLocations=193&notLocations=194&notLocations=195`"
    },
    "parts": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple part IDs: `parts=14677&parts=14687`"
    },
    "notParts": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Filter work orders that have none of the provided parts. To filter by multiple part IDs: `notParts=14677&notParts=14687`"
    },
    "vendors": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple vendor IDs: `vendors=7123&vendors=2234`"
    },
    "notVendors": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Filter work orders that have none of the provided vendors. To filter by multiple vendor IDs: `notVendors=7123&notVendors=2234`"
    },
    "assignees": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple assignee IDs: `assignees=23494&assignees=79808`"
    },
    "teams": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple team IDs: `teams=112&teams=243`"
    },
    "categories": {
      "type": "array",
      "description": "To filter by multiple categories: `categories=123456&categories=Damage`"
    },
    "notCategories": {
      "type": "array",
      "description": "Filter work orders that have none of the provided categories. To filter by multiple categories: `notCategories=123456&notCategories=Damage`"
    },
    "priorities": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "NONE",
          "LOW",
          "MEDIUM",
          "HIGH"
        ]
      },
      "description": "To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`"
    },
    "statuses": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "OPEN",
          "IN_PROGRESS",
          "ON_HOLD",
          "DONE",
          "CANCELED",
          "SKIPPED"
        ]
      },
      "description": "To filter by multiple statuses: `statuses=IN_PROGRESS&statuses=DONE`"
    },
    "show_upcoming": {
      "type": "boolean",
      "description": "Include work orders with a future start date"
    },
    "sort": {
      "type": "string",
      "description": "Attribute on which to sort the list. (for descending order, prefix attribute with '-').",
      "enum": [
        "updatedAt",
        "createdAt",
        "dueDate",
        "startedAt",
        "completedAt",
        "-updatedAt",
        "-createdAt",
        "-dueDate",
        "-startedAt",
        "-completedAt"
      ]
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "thumbnail",
          "assignees",
          "categories",
          "parts",
          "asset",
          "location",
          "procedure",
          "vendor_ids",
          "times",
          "time_items",
          "expenditures",
          "extra_fields",
          "estimated_time"
        ]
      },
      "description": "To expand multiple fields: `expand=thumbnail&expand=assignees`"
    },
    "x-organization-id": {
      "type": "integer",
      "description": "Required if using a multi organizations token"
    }
  },
  "required": [
    "PCID"
  ]
}

maintainx_work_orders_list_workorders_comments

List work order comments Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Comments returned

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Comments returned"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_list_workorders_subworkorders

List sub work orders Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Subworkorders returned
`expand`	string[]	No	—	To expand multiple fields: `expand=assignees&expand=asset`

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Subworkorders returned"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "assignees",
          "asset",
          "categories",
          "estimated_time",
          "location",
          "parts",
          "procedure",
          "times",
          "time_items",
          "expenditures",
          "extra_fields"
        ]
      },
      "description": "To expand multiple fields: `expand=assignees&expand=asset`"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_list_workrequestportals

List work request portals Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Work Request Portals returned
`x-organization-id`	integer	No	—	Required if using a multi organizations token

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Work Request Portals returned"
    },
    "x-organization-id": {
      "type": "integer",
      "description": "Required if using a multi organizations token"
    }
  },
  "required": [
    "PCID"
  ]
}

maintainx_work_orders_list_workrequests

List work requests Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	Last pagination reference
`limit`	integer	No	—	max number of Work Requests returned
`title`	string	No	—	To filter work orders by title or sequential ID
`assets`	integer[]	No	—	To filter by multiple asset IDs: `assets=630&assets=634`
`locations`	integer[]	No	—	To filter by multiple location IDs: `locations=193&locations=194&locations=195`
`priorities`	string[]	No	—	To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`
`statuses`	string[]	No	—	To filter by multiple statuses: `statuses=APPROVED&statuses=DONE`
`expand`	string[]	No	—	To expand multiple fields: `expand=asset&expand=location`
`x-organization-id`	integer	No	—	Required if using a multi organizations token

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Last pagination reference"
    },
    "limit": {
      "type": "integer",
      "description": "max number of Work Requests returned"
    },
    "title": {
      "type": "string",
      "description": "To filter work orders by title or sequential ID"
    },
    "assets": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple asset IDs: `assets=630&assets=634`"
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "To filter by multiple location IDs: `locations=193&locations=194&locations=195`"
    },
    "priorities": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "NONE",
          "LOW",
          "MEDIUM",
          "HIGH"
        ]
      },
      "description": "To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`"
    },
    "statuses": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "PENDING",
          "REJECTED",
          "APPROVED",
          "DONE"
        ]
      },
      "description": "To filter by multiple statuses: `statuses=APPROVED&statuses=DONE`"
    },
    "expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "asset",
          "location",
          "work_order",
          "extra_fields"
        ]
      },
      "description": "To expand multiple fields: `expand=asset&expand=location`"
    },
    "x-organization-id": {
      "type": "integer",
      "description": "Required if using a multi organizations token"
    }
  },
  "required": [
    "PCID"
  ]
}

maintainx_work_orders_update_workorders

Update work order Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`assetId`	integer	No	—	Asset Id
`assignees`	object[]	No	—	Either the teamId, the userId or the user email address
`categories`	string[]	No	—	List of categories that identify the work order
`description`	string	No	—	The description value
`dueDate`	string	No	—	Date & time at which the work order is due
`estimatedTime`	integer	No	—	The estimated time taken in seconds to complete the work order
`externalData`	object	No	—	Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
`extraFields`	object	No	—	Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Estimated Time Allotted”)
`locationId`	integer	No	—	Global ID of the location assigned to the work order
`partsUsed`	object[]	No	—	Parts IDs and quantities used in this work order
`priority`	string	No	—	The priority value
`procedure`	object	No	—	The procedure value
`procedureTemplateId`	number	No	—	ID of the procedure template to attach
`recurrenceInfo`	object	No	—	Recurrence Info
`requesterId`	object	No	—	ID or email of the user who requested the work order
`startDate`	string	No	—	Date & time at which the work order will show up in the inbox</br>Only valid when <b>dueDate</b> is set
`title`	string	No	—	The title value
`type`	string	No	—	Valid types of Work Orders.
`vendorIds`	number[]	No	—	Vendor IDs

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    },
    "skipWebhook": {
      "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)"
    },
    "assetId": {
      "type": "integer",
      "description": "Asset Id"
    },
    "assignees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "USER",
              "TEAM"
            ],
            "description": "The type value"
          },
          "id": {
            "description": "The id value"
          }
        },
        "required": [
          "type",
          "id"
        ]
      },
      "description": "Either the teamId, the userId or the user email address"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of categories that identify the work order"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "dueDate": {
      "type": "string",
      "description": "Date & time at which the work order is due"
    },
    "estimatedTime": {
      "type": "integer",
      "description": "The estimated time taken in seconds to complete the work order"
    },
    "externalData": {
      "description": "Extra data that can be attached to the work order, for example to help reference to a matching record in an external system."
    },
    "extraFields": {
      "type": "object",
      "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"Estimated Time Allotted\")"
    },
    "locationId": {
      "type": "integer",
      "description": "Global ID of the location assigned to the work order"
    },
    "partsUsed": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "partId": {
            "type": "integer",
            "description": "Global ID of the part"
          },
          "quantityUsed": {
            "type": "integer",
            "description": "Quantity used in the work order."
          },
          "locationId": {
            "type": "integer",
            "description": "Global ID of the location of the part"
          },
          "copyOnRecurring": {
            "type": "string",
            "enum": [
              "NoCopy",
              "Copy",
              "Default"
            ],
            "description": "Indicates if the parts will be copied to the next work order in the chain (if applicable)."
          }
        },
        "required": [
          "partId"
        ]
      },
      "description": "Parts IDs and quantities used in this work order"
    },
    "priority": {
      "type": "string",
      "description": "The priority value",
      "enum": [
        "NONE",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "procedure": {
      "type": "object",
      "description": "The procedure value",
      "properties": {
        "id": {
          "type": "number",
          "description": "You should favor 'procedureTemplateId' to attach a procedure template."
        },
        "title": {
          "type": "string",
          "description": "Title of the procedure"
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "Steps of a procedure"
        }
      },
      "required": [
        "title",
        "fields"
      ]
    },
    "procedureTemplateId": {
      "type": "number",
      "description": "ID of the procedure template to attach"
    },
    "recurrenceInfo": {
      "type": "object",
      "description": "Recurrence Info"
    },
    "requesterId": {
      "description": "ID or email of the user who requested the work order"
    },
    "startDate": {
      "type": "string",
      "description": "Date & time at which the work order will show up in the inbox</br>Only valid when <b>dueDate</b> is set"
    },
    "title": {
      "type": "string",
      "description": "The title value"
    },
    "type": {
      "type": "string",
      "description": "Valid types of Work Orders.",
      "enum": [
        "OTHER",
        "REACTIVE",
        "PREVENTIVE"
      ]
    },
    "vendorIds": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Vendor IDs"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_update_workorders_procedure_fields_attachment

Update procedure field attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order
`index`	integer	Yes	—	Sequential index of the field in the procedure
`filename`	string	Yes	—	Name of the attachment, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`body`	object	Yes	—	Content type should be `application/octet-stream` and payload should use binary format for the attachment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order"
    },
    "index": {
      "type": "integer",
      "description": "Sequential index of the field in the procedure"
    },
    "filename": {
      "type": "string",
      "description": "Name of the attachment, including the extension."
    },
    "skipWebhook": {
      "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)"
    },
    "body": {
      "type": "object",
      "description": "Content type should be `application/octet-stream` and payload should use binary format for the attachment."
    }
  },
  "required": [
    "PCID",
    "id",
    "index",
    "filename",
    "body"
  ]
}

maintainx_work_orders_update_workorders_status

Update work order status Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the workOrder
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`status`	string	No	—	<br /><em>Note:</em> It is also possible to register a webhook to get notified when the status of any work order changes. Please see the <a href=“#tag/Subscriptions”>Subscriptions</a> section for more information.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the workOrder"
    },
    "skipWebhook": {
      "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)"
    },
    "status": {
      "type": "string",
      "description": "<br /><em>Note:</em> It is also possible to register a webhook to get notified when the status of any work order changes. Please see the <a href=\"#tag/Subscriptions\">Subscriptions</a> section for more information.",
      "enum": [
        "OPEN",
        "IN_PROGRESS",
        "ON_HOLD",
        "DONE",
        "CANCELED"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_update_workrequestportals

Update work request portal Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work request portal
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`assetId`	integer	No	—	ID of the asset related to the portal
`contactInformation`	string	No	—	Contact of the person creating the portal (email or phone number)
`descriptionPlaceholder`	string	No	—	Placeholder text for the description field
`emailOnly`	boolean	No	—	Allow request creation with email only to contact the requester
`locationId`	integer	No	—	ID of the location where the portal is located
`sendEmailNotification`	boolean	No	—	Send email notifications to the portal requesters with status updates on their requests
`title`	string	No	—	Title of the portal
`welcomeText`	string	No	—	Description text describing the portal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work request portal"
    },
    "skipWebhook": {
      "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)"
    },
    "assetId": {
      "type": "integer",
      "description": "ID of the asset related to the portal"
    },
    "contactInformation": {
      "type": "string",
      "description": "Contact of the person creating the portal (email or phone number)"
    },
    "descriptionPlaceholder": {
      "type": "string",
      "description": "Placeholder text for the description field"
    },
    "emailOnly": {
      "type": "boolean",
      "description": "Allow request creation with email only to contact the requester"
    },
    "locationId": {
      "type": "integer",
      "description": "ID of the location where the portal is located"
    },
    "sendEmailNotification": {
      "type": "boolean",
      "description": "Send email notifications to the portal requesters with status updates on their requests"
    },
    "title": {
      "type": "string",
      "description": "Title of the portal"
    },
    "welcomeText": {
      "type": "string",
      "description": "Description text describing the portal"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_update_workrequests

Update work request Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work request
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`approverTeamId`	number	No	—	ID of the team that is reponsible for approving the request.
`assetId`	number	No	—	Asset Id
`creatorContactInfo`	string	No	—	The creator’s contact information associated with this work order request. Possible types are `EMAIL`, `PHONE`, and `OTHER`, which will be inferred from the string provided
`description`	string	No	—	The description value
`extraFields`	object	No	—	Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Request Type”)
`locationId`	number	No	—	Location Id
`priority`	string	No	—	The priority value
`title`	string	No	—	The title value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work request"
    },
    "skipWebhook": {
      "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)"
    },
    "approverTeamId": {
      "type": "number",
      "description": "ID of the team that is reponsible for approving the request."
    },
    "assetId": {
      "type": "number",
      "description": "Asset Id"
    },
    "creatorContactInfo": {
      "type": "string",
      "description": "The creator's contact information associated with this work order request. Possible types are `EMAIL`, `PHONE`, and `OTHER`, which will be inferred from the string provided"
    },
    "description": {
      "type": "string",
      "description": "The description value"
    },
    "extraFields": {
      "type": "object",
      "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"Request Type\")"
    },
    "locationId": {
      "type": "number",
      "description": "Location Id"
    },
    "priority": {
      "type": "string",
      "description": "The priority value",
      "enum": [
        "NONE",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "title": {
      "type": "string",
      "description": "The title value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

maintainx_work_orders_upload_workorders_attachments

Update work order attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order.
`filename`	string	Yes	—	Name of the attachment, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`body`	object	Yes	—	Content type should be `application/octet-stream` and payload should use binary format for the attachment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order."
    },
    "filename": {
      "type": "string",
      "description": "Name of the attachment, including the extension."
    },
    "skipWebhook": {
      "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)"
    },
    "body": {
      "type": "object",
      "description": "Content type should be `application/octet-stream` and payload should use binary format for the attachment."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename",
    "body"
  ]
}

maintainx_work_orders_upload_workorders_thumbnail

Update work order’s thumbnail Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work order.
`filename`	string	Yes	—	Name of the work order thumbnail, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`body`	object	Yes	—	Content type should be `application/octet-stream` and payload should use binary format for the thumbnail.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work order."
    },
    "filename": {
      "type": "string",
      "description": "Name of the work order thumbnail, including the extension."
    },
    "skipWebhook": {
      "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)"
    },
    "body": {
      "type": "object",
      "description": "Content type should be `application/octet-stream` and payload should use binary format for the thumbnail."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename",
    "body"
  ]
}

maintainx_work_orders_upload_workrequests_attachments

Update work request attachment Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work request.
`filename`	string	Yes	—	Name of the attachment, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`body`	object	Yes	—	Content type should be `application/octet-stream` and payload should use binary format for the attachment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work request."
    },
    "filename": {
      "type": "string",
      "description": "Name of the attachment, including the extension."
    },
    "skipWebhook": {
      "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)"
    },
    "body": {
      "type": "object",
      "description": "Content type should be `application/octet-stream` and payload should use binary format for the attachment."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename",
    "body"
  ]
}

maintainx_work_orders_upload_workrequests_thumbnail

Update work request’s thumbnail Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	ID of the work request.
`filename`	string	Yes	—	Name of the work request thumbnail, including the extension.
`skipWebhook`	boolean	No	—	Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks
`body`	object	Yes	—	Content type should be `application/octet-stream` and payload should use binary format for the thumbnail.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "ID of the work request."
    },
    "filename": {
      "type": "string",
      "description": "Name of the work request thumbnail, including the extension."
    },
    "skipWebhook": {
      "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)"
    },
    "body": {
      "type": "object",
      "description": "Content type should be `application/octet-stream` and payload should use binary format for the thumbnail."
    }
  },
  "required": [
    "PCID",
    "id",
    "filename",
    "body"
  ]
}

Platform API

Embedded MCP Servers

Application MCP Servers

Triggers API

Tools

maintainx_work_orders_create_workorders

maintainx_work_orders_create_workorders_comments

maintainx_work_orders_create_workorders_costs

maintainx_work_orders_create_workorders_emails

maintainx_work_orders_create_workpermits_sign

maintainx_work_orders_create_workrequestportals

maintainx_work_orders_create_workrequests

maintainx_work_orders_delete_workorders

maintainx_work_orders_delete_workorders_attachments

maintainx_work_orders_delete_workorders_procedure

maintainx_work_orders_delete_workorders_procedure_fields_attachment

maintainx_work_orders_delete_workrequestportals

maintainx_work_orders_delete_workrequests

maintainx_work_orders_delete_workrequests_attachments

maintainx_work_orders_get_workorders

maintainx_work_orders_get_workorders_comments

maintainx_work_orders_get_workorders_costs

maintainx_work_orders_get_workorders_subworkorders

maintainx_work_orders_get_workrequestportals

maintainx_work_orders_get_workrequests

maintainx_work_orders_list_workorders

maintainx_work_orders_list_workorders_comments

maintainx_work_orders_list_workorders_subworkorders

maintainx_work_orders_list_workrequestportals

maintainx_work_orders_list_workrequests

maintainx_work_orders_update_workorders

maintainx_work_orders_update_workorders_procedure_fields_attachment

maintainx_work_orders_update_workorders_status

maintainx_work_orders_update_workrequestportals

maintainx_work_orders_update_workrequests

maintainx_work_orders_upload_workorders_attachments

maintainx_work_orders_upload_workorders_thumbnail

maintainx_work_orders_upload_workrequests_attachments

maintainx_work_orders_upload_workrequests_thumbnail

​Tools

​maintainx_work_orders_create_workorders

​maintainx_work_orders_create_workorders_comments

​maintainx_work_orders_create_workorders_costs

​maintainx_work_orders_create_workorders_emails

​maintainx_work_orders_create_workpermits_sign

​maintainx_work_orders_create_workrequestportals

​maintainx_work_orders_create_workrequests

​maintainx_work_orders_delete_workorders

​maintainx_work_orders_delete_workorders_attachments

​maintainx_work_orders_delete_workorders_procedure

​maintainx_work_orders_delete_workorders_procedure_fields_attachment

​maintainx_work_orders_delete_workrequestportals

​maintainx_work_orders_delete_workrequests

​maintainx_work_orders_delete_workrequests_attachments

​maintainx_work_orders_get_workorders

​maintainx_work_orders_get_workorders_comments

​maintainx_work_orders_get_workorders_costs

​maintainx_work_orders_get_workorders_subworkorders

​maintainx_work_orders_get_workrequestportals

​maintainx_work_orders_get_workrequests

​maintainx_work_orders_list_workorders

​maintainx_work_orders_list_workorders_comments

​maintainx_work_orders_list_workorders_subworkorders

​maintainx_work_orders_list_workrequestportals

​maintainx_work_orders_list_workrequests

​maintainx_work_orders_update_workorders

​maintainx_work_orders_update_workorders_procedure_fields_attachment

​maintainx_work_orders_update_workorders_status

​maintainx_work_orders_update_workrequestportals

​maintainx_work_orders_update_workrequests

​maintainx_work_orders_upload_workorders_attachments

​maintainx_work_orders_upload_workorders_thumbnail

​maintainx_work_orders_upload_workrequests_attachments

​maintainx_work_orders_upload_workrequests_thumbnail

Tools

maintainx_work_orders_create_workorders

maintainx_work_orders_create_workorders_comments

maintainx_work_orders_create_workorders_costs

maintainx_work_orders_create_workorders_emails

maintainx_work_orders_create_workpermits_sign

maintainx_work_orders_create_workrequestportals

maintainx_work_orders_create_workrequests

maintainx_work_orders_delete_workorders

maintainx_work_orders_delete_workorders_attachments

maintainx_work_orders_delete_workorders_procedure

maintainx_work_orders_delete_workorders_procedure_fields_attachment

maintainx_work_orders_delete_workrequestportals

maintainx_work_orders_delete_workrequests

maintainx_work_orders_delete_workrequests_attachments

maintainx_work_orders_get_workorders

maintainx_work_orders_get_workorders_comments

maintainx_work_orders_get_workorders_costs

maintainx_work_orders_get_workorders_subworkorders

maintainx_work_orders_get_workrequestportals

maintainx_work_orders_get_workrequests

maintainx_work_orders_list_workorders

maintainx_work_orders_list_workorders_comments

maintainx_work_orders_list_workorders_subworkorders

maintainx_work_orders_list_workrequestportals

maintainx_work_orders_list_workrequests

maintainx_work_orders_update_workorders

maintainx_work_orders_update_workorders_procedure_fields_attachment

maintainx_work_orders_update_workorders_status

maintainx_work_orders_update_workrequestportals

maintainx_work_orders_update_workrequests

maintainx_work_orders_upload_workorders_attachments

maintainx_work_orders_upload_workorders_thumbnail

maintainx_work_orders_upload_workrequests_attachments

maintainx_work_orders_upload_workrequests_thumbnail