Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Procedure Templates

List procedure templates

Endpoint used to list procedure template resources

get/proceduretemplates

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"
            }
          ]
        }
      ]
    }
  ]
}