GEgetmaintainx
Work Requests

Create work request

Changed on
post/workrequests

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

descriptionstring nullable
priority'NONE' | 'LOW' | 'MEDIUM' | 'HIGH'
titlestring required
assetIdnumber nullable
locationIdnumber nullable
extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Request Type")

approverTeamIdnumber nullable

ID of the team that is reponsible for approving the request.

creatorContactInfostring nullable

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

externalIdstring nullable

External ID for this work request, unique per organization.

Example request

{
  "description": "A forklift that needs to be reviewed for any potential problems",
  "priority": "MEDIUM",
  "title": "Forklift Preventive Maintenance Form",
  "assetId": 843,
  "locationId": 852,
  "extraFields": {
    "Request Type": "Water Leak"
  },
  "approverTeamId": 254,
  "creatorContactInfo": "james@example.com",
  "externalId": "ext-workrequest-001"
}

Response

Successfully created work request

idnumber required

Global ID of the work request

Example response

{
  "id": 963
}

Changes

  • dff2bfdd78faRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

  • 222e6fad7c1fRevision changes
    • breaking

      removed the media type application/octet-stream from the request body

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable