GEgetmaintainx
Procedure Templates

List procedure templates

Changed on

Endpoint used to list procedure template resources

get/proceduretemplates

Request

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

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Procedure Templates returned

expandstring[]

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Procedure Templates list

nextCursorstring nullable required

The cursor to retrieve the next page of Procedure Templates.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Procedure Templates.

Example response

{
  "procedureTemplates": [
    {
      "rows": [
        {
          "id": 1,
          "label": "Metal Parts: broken, loose, dented, rusty, missing",
          "type": "INSPECTION_CHECK",
          "choices": [
            "Partially"
          ],
          "attachmentId": 1,
          "attachments": [
            {
              "id": 12345,
              "mimeType": "image/png",
              "fileName": "image.png",
              "url": "http://example.com/image.png",
              "createdAt": "2022-01-01T00:00:00.000Z",
              "width": 220,
              "height": 100
            }
          ],
          "urls": [
            {
              "label": "MaintainX Website",
              "link": "www.getmaintainx.com"
            }
          ]
        }
      ]
    }
  ]
}

Changes

  • 64746cdb0db4Revision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 222e6fad7c1fRevision changes
    • warning

      added the new CYCLE_COUNT enum value to the //// response property for the response status

    • warning

      added the new UNSUPPORTED enum value to the //// response property for the response status

    • info

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

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status