MaintainX

App · 25 actions

Manage work orders, work requests, assets and locations, and look up teams and users.

Actions

ActionWhat it does
Create assetCreate new asset.
Create locationCreate new location.
Create work orderCreate new work order.
Create work order commentCreate new comment on a work order.
Create work requestCreate work request.
Delete assetDelete asset.
Delete locationDelete location.
Delete work orderDelete workOrder.
Delete work requestDelete workRequest.
Get assetGet asset.
Get locationGet location.
Get work orderGet work order.
Get work requestGet work request.
List assetsList assets.
List locationsList locations.
List procedure templatesList procedure templates.
List teamsList teams.
List usersList users.
List work order commentsList work order comments.
List work ordersList work orders.
List work requestsList work requests.
Set work order statusUpdate work order status.
Update assetUpdate asset.
Update locationUpdate location.
Update work orderUpdate work order.

Create asset

Create new asset.

Inputs

Skip webhookskip_webhooktrue/false
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 idx_organization_idtext
Required if using a multi organizations token
NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
Barcodebarcodetext
String encoded barcode
Criticality idcriticality_idtext
ID of the criticality of the asset
Parent idparent_idtext
ID of the parent asset
Locationlocation_idtext
ID of the location where the asset is located
Team idsteam_idslist
List of teams responsible for the asset
Asset typesasset_typeslist
List of asset types
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "My Custom Field")
Vendor idsvendor_idslist
Vendor IDs
Serial numberserial_numbertext
Serial number of the asset
Depreciationdepreciationobject
Depreciation information of the asset
External idexternal_idtext
External ID for this asset, unique per organization.
Manufacturermanufacturerobject
Manufacturer information for the asset. Set to null to clear manufacturer and model.
Modelmodelobject
Model information for the asset. Set to null to clear model.

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "id": 1
  }
}

Create location

Create new location.

Inputs

Skip webhookskip_webhooktrue/false
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 idx_organization_idtext
Required if using a multi organizations token
NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
Addressaddresstext
Postal address of the location
Barcodebarcodetext
String encoded barcode
Parent idparent_idtext
ID of the parent location
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")
Vendor idsvendor_idslist
Vendor IDs
External idexternal_idtext
External ID for this location, unique per organization.

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "id": 1
  }
}

Create work order

Create new work order.

Inputs

Skip webhookskip_webhooktrue/false
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 idx_organization_idtext
Required if using a multi organizations token
Assetasset_idtext
Asset id.
Assigneesassigneeslist
Either the teamId, the userId or the user email address
Estimated timeestimated_timenumber
The estimated time taken in seconds to complete the work order
Requesterrequester_idtext
ID or email of the user who requested the work order
Work request idwork_request_idtext
ID of the Work Request that will be approved by the creation of this work order
Work order template idwork_order_template_idtext
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.
Categoriescategorieslist
List of categories that identify the work order
Descriptiondescriptiontext
Description.
Due datedue_datedate and time
Date & time at which the work order is due
External dataexternal_dataobject
Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
External idexternal_idtext
External ID for this work order, unique per organization.
Is parentis_parenttrue/false
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. Learn moreMutually exclusive with **parentId**
Start datestart_datedate and time
Date & time at which the work order will show up in the inboxOnly valid when dueDate is set
Locationlocation_idtext
Global ID of the location assigned to the work order
Priorityprioritytext
Priority.One of: NONE, LOW, MEDIUM, HIGH.
Procedureprocedureobject
Procedure.
Procedure templateprocedure_template_idnumber
ID of the procedure template to attach
Repeatabilityrepeatabilityobject
Repeatability.
Skip rest hookskip_rest_hooktrue/false
When work order is created, will not trigger any rest hook that is subscribed
TitletitletextRequired
Title.
Typetypetext
Valid types of Work Orders.One of: OTHER, REACTIVE, PREVENTIVE.
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Estimated Time Allotted")
Vendor idsvendor_idslist
Vendor IDs
Parts usedparts_usedlist
Parts IDs and quantities used in this work order
Parent idparent_idnumber
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. Learn moreMutually exclusive with **isParent**

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "id": 1.0
  }
}

Create work order comment

Create new comment on a work order.

Inputs

Work order IDidtextRequired
Global ID of the work order
Skip webhookskip_webhooktrue/false
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)
ContentcontenttextRequired
Content of the comment to post

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "id": 1.0
  }
}

Create work request

Create work request.

Inputs

Skip webhookskip_webhooktrue/false
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 idx_organization_idtext
Required if using a multi organizations token
Descriptiondescriptiontext
Description.
Priorityprioritytext
Priority.One of: NONE, LOW, MEDIUM, HIGH.
TitletitletextRequired
Title.
Assetasset_idnumber
Asset id.
Locationlocation_idnumber
Location id.
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Request Type")
Approver team idapprover_team_idnumber
ID of the team that is reponsible for approving the request.
Creator contact infocreator_contact_infotext
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
External idexternal_idtext
External ID for this work request, unique per organization.

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "id": 1.0
  }
}

Delete asset

Delete asset.

Inputs

Asset IDidtextRequired
ID of the asset
Skip webhookskip_webhooktrue/false
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)

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {}
}

Delete location

Delete location.

Inputs

Location IDidtextRequired
ID of the location
Skip webhookskip_webhooktrue/false
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)

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {}
}

Delete work order

Delete workOrder.

Inputs

Work order IDidtextRequired
ID of the workOrder
Skip webhookskip_webhooktrue/false
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)

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {}
}

Delete work request

Delete workRequest.

Inputs

Work request IDidtextRequired
ID of the workRequest
Skip webhookskip_webhooktrue/false
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)

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {}
}

Get asset

Get asset.

Inputs

Asset IDidtextRequired
ID of the asset

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "asset": {
      "assetTypes": [],
      "attachments": [],
      "barcode": "example",
      "childrenIds": [],
      "createdAt": "example",
      "creatorId": 1,
      "criticalityId": 1,
      "currentOwnerId": 1.0,
      "deletedAt": "example",
      "depreciation": {
        "accumulatedDepreciation": 1.0,
        "annualDepreciation": 1.0,
        "archivedAt": "example",
        "createdAt": "example",
        "currentBookValue": 1.0,
        "depreciationStartDate": "example",
        "id": 1.0,
        "purchaseDate": "example",
        "purchasePrice": 1.0,
        "salvageValue": 1.0,
        "usefulLifeYears": 1.0,
        "yearsDepreciated": 1.0
      },
      "description": "example",
      "externalId": "example",
      "extraFields": {},
      "globalUuid": "example",
      "id": 1,
      "locationId": 1,
      "manufacturer": "example",
      "model": "example",
      "name": "example",
      "parentId": 1,
      "serialNumber": "example",
      "status": {
        "createdAt": "example",
        "customStatus": {
          "createdAt": "example",
          "deletedAt": "example",
          "downtimeType": "PLANNED",
          "id": 1.0,
          "label": "example",
          "updatedAt": "example"
        },
        "customStatusId": 1.0,
        "deletedAt": "example",
        "description": "example",
        "downtimeType": "PLANNED",
        "endedAt": "example",
        "id": 1.0,
        "startedAt": "example",
        "status": "IGNORE",
        "updatedAt": "example"
      },
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "updatedAt": "example",
      "vendorIds": []
    }
  }
}

Get location

Get location.

Inputs

Location IDidtextRequired
ID of the location

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "location": {
      "address": "example",
      "attachments": [],
      "barcode": "example",
      "childrenIds": [],
      "createdAt": "example",
      "deletedAt": "example",
      "description": "example",
      "externalId": "example",
      "extraFields": {},
      "id": 1,
      "name": "example",
      "parentId": 1,
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "updatedAt": "example",
      "vendorIds": []
    }
  }
}

Get work order

Get work order.

Inputs

Work order IDidtextRequired
ID of the workOrder
Expandexpandlist
To expand multiple fields: `expand=assignees&expand=asset`One or more of: assignees, asset, estimated_time (Estimated time), location, parts, times, time_items (Time items), expenditures, extra_fields (Extra fields), part_extra_fields (Part extra fields), asset_extra_fields (Asset extra fields), location_extra_fields (Location extra fields).
Use sequential iduse_sequential_idtrue/false
Whether to use the sequential ID instead of the global ID

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "workOrder": {
      "asset": {
        "assetExtraFields": {},
        "createdAt": "example",
        "creatorId": 1,
        "criticalityId": 1,
        "description": "example",
        "id": 1,
        "locationId": 1,
        "name": "example",
        "parentId": 1,
        "serialNumber": "example",
        "updatedAt": "example"
      },
      "assetId": 1,
      "assigneeIds": [],
      "assignees": [],
      "attachments": [],
      "categories": [],
      "completedAt": "example",
      "completerId": 1,
      "createdAt": "example",
      "creatorId": 1,
      "customerId": 1,
      "deletedAt": "example",
      "description": "example",
      "dueDate": "example",
      "dueDateIsFullDay": false,
      "estimatedTime": 1,
      "expenditures": [],
      "externalData": {},
      "externalId": "example",
      "extraFields": {},
      "id": 1,
      "isParent": false,
      "lastMessageSentAt": "example",
      "location": {
        "address": "example",
        "createdAt": "example",
        "description": "example",
        "id": 1,
        "locationExtraFields": {},
        "name": "example",
        "parentId": 1,
        "updatedAt": "example"
      },
      "locationId": 1,
      "nextId": 1,
      "organizationId": 1.0,
      "parentId": 1,
      "partStatus": "NO_PARTS",
      "parts": [],
      "partsAvailability": "PARTS_AVAILABLE",
      "previousId": 1,
      "priority": "NONE",
      "procedure": {
        "fields": [],
        "id": 1.0,
        "maxScore": 1.0,
        "score": 1.0,
        "templateIds": [],
        "title": "example"
      },
      "progress": {
        "doneCount": 1.0,
        "inProgressCount": 1.0,
        "onHoldCount": 1.0,
        "openCount": 1.0
      },
      "recurrenceInfo": {},
      "requesterId": 1,
      "sequentialId": 1,
      "startDate": "example",
      "status": "OPEN",
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "timeItems": [],
      "times": [],
      "title": "example",
      "type": "CYCLE_COUNT",
      "updatedAt": "example",
      "vendorIds": [],
      "workOrderSummary": {
        "authorId": 1,
        "content": "example",
        "summary": "example"
      }
    }
  }
}

Get work request

Get work request.

Inputs

Work request IDidtextRequired
ID of the workRequest
Expandexpandlist
To expand multiple fields: `expand=asset&expand=location`One or more of: asset, location, work_order (Work order), extra_fields (Extra fields).

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "workRequest": {
      "approverTeamId": 1.0,
      "asset": {
        "createdAt": "example",
        "creatorId": 1,
        "criticalityId": 1,
        "description": "example",
        "id": 1,
        "locationId": 1,
        "name": "example",
        "parentId": 1,
        "serialNumber": "example",
        "updatedAt": "example"
      },
      "assetId": 1.0,
      "attachments": [],
      "createdAt": "example",
      "creatorContactInfo": {
        "type": "PHONE",
        "value": "example"
      },
      "description": "example",
      "externalId": "example",
      "extraFields": {},
      "id": 1.0,
      "location": {
        "address": "example",
        "createdAt": "example",
        "description": "example",
        "id": 1,
        "name": "example",
        "parentId": 1,
        "updatedAt": "example"
      },
      "locationId": 1.0,
      "priority": "NONE",
      "requestStatus": "PENDING",
      "sendEmailNotification": false,
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "title": "example",
      "updatedAt": "example",
      "workOrder": {
        "assetId": 1,
        "assigneeIds": [],
        "attachments": [],
        "categories": [],
        "completedAt": "example",
        "completerId": 1,
        "createdAt": "example",
        "creatorId": 1,
        "customerId": 1,
        "deletedAt": "example",
        "description": "example",
        "dueDate": "example",
        "dueDateIsFullDay": false,
        "estimatedTime": 1,
        "externalData": {},
        "externalId": "example",
        "extraFields": {},
        "id": 1,
        "isParent": false,
        "lastMessageSentAt": "example",
        "locationId": 1,
        "nextId": 1,
        "organizationId": 1.0,
        "parentId": 1,
        "partStatus": "NO_PARTS",
        "partsAvailability": "PARTS_AVAILABLE",
        "previousId": 1,
        "priority": "NONE",
        "procedure": {
          "fields": [],
          "id": 1.0,
          "maxScore": 1.0,
          "score": 1.0,
          "templateIds": [],
          "title": "example"
        },
        "progress": {
          "doneCount": 1.0,
          "inProgressCount": 1.0,
          "onHoldCount": 1.0,
          "openCount": 1.0
        },
        "recurrenceInfo": {},
        "requesterId": 1,
        "sequentialId": 1,
        "startDate": "example",
        "status": "OPEN",
        "teamIds": [],
        "thumbnail": {
          "createdAt": "example",
          "fileName": "example",
          "height": 1.0,
          "id": 1.0,
          "mimeType": "example",
          "url": "example",
          "width": 1.0
        },
        "title": "example",
        "type": "CYCLE_COUNT",
        "updatedAt": "example",
        "vendorIds": [],
        "workOrderSummary": {
          "authorId": 1,
          "content": "example",
          "summary": "example"
        }
      },
      "workOrderId": 1.0
    }
  }
}

List assets

List assets.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Assets returnedFrom 1 to 200. Default: 100.
Locationlocation_idtext
Will only show assets that are related to the location
Manufacturermanufacturerlist
Filter assets by their manufacturer name
Modelmodellist
Filter assets by their manufacturer model name
Updated at gteupdated_at_gtedate and time
Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).
Updated at lteupdated_at_ltedate and time
Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).
Created at gtecreated_at_gtedate and time
Return records whose createdAt is at or after this ISO 8601 date-time (UTC).
Created at ltecreated_at_ltedate and time
Return records whose createdAt is at or before this ISO 8601 date-time (UTC).
Custom field namecustom_field_namelist
Filter assets by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/assets?Industry=Construction"). Adding multiple instance of the same custom field act as an OR and adding a different custom field act as an AND. (ie: To filter by a custom field named Industry with the value Construction OR Transportation AND the custom field Manufacturer with the value ACME, you would do this /assets?Industry=Construction&Industry=Transportation&Manufacturer=ACME). If your custom field label is the same as a reserved query parameter such as limit, sort, expand, etc, you can add __c to your custom field filtering (ie: To filter by a custom field named limit with the value ten, you would do this /assets?limit__c=ten). Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported.
Sortsorttext
Attribute on which to sort the list. (for descending order, prefix attribute with '-').One of: id, createdAt, updatedAt, -id, -createdAt, -updatedAt.
Expandexpandlist
To expand multiple fields: `expand=barcode&expand=team_ids`One or more of: barcode, team_ids (Team ids), asset_types (Asset types), extra_fields (Extra fields), vendor_ids (Vendor ids), depreciation, status, manufacturer, model.
X organization idx_organization_idtext
Required if using a multi organizations token
X organization idsx_organization_idstext
Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other).

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "assets": [],
    "nextCursor": "example",
    "nextPageUrl": "example"
  }
}

List locations

List locations.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Locations returnedFrom 1 to 200. Default: 100.
Namenametext
Will only show locations that have a name starting with this.
Custom field namecustom_field_namelist
Filter locations by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/locations?Industry=Construction"). Adding multiple instance of the same custom field act as an OR and adding a different custom field act as an AND. (ie: To filter by a custom field named Industry with the value Construction OR Transportation AND the custom field Manufacturer with the value ACME, you would do this /locations?Industry=Construction&Industry=Transportation&Manufacturer=ACME). If your custom field label is the same as a reserved query parameter such as limit, sort, expand, etc, you can add __c to your custom field filtering (ie: To filter by a custom field named limit with the value ten, you would do this /locations?limit__c=ten). Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported.
Expandexpandlist
To expand multiple fields: `expand=extra_fields&expand=team_ids`One or more of: extra_fields (Extra fields), team_ids (Team ids), vendor_ids (Vendor ids), barcode.
X organization idx_organization_idtext
Required if using a multi organizations token
X organization idsx_organization_idstext
Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other).

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "locations": [],
    "nextCursor": "example",
    "nextPageUrl": "example"
  }
}

List procedure templates

List procedure templates.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Procedure Templates returnedFrom 1 to 200. Default: 100.
Expandexpandlist
Expand.One or more of: rows.
X organization idx_organization_idtext
Required if using a multi organizations token

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "procedureTemplates": []
  }
}

List teams

List teams.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Teams returnedFrom 1 to 200. Default: 100.
X organization idx_organization_idtext
Required if using a multi organizations token

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "teams": []
  }
}

List users

List users.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Users returnedFrom 1 to 200. Default: 100.
Only assignableonly_assignabletrue/false
Will only show users that can be assigned to a work order
Emailemaillist
Filter users by email. You can filter for multiple users by specifying multiple emails like so: `/users?email=user1@example.com&email=user2@example.com`. Note that if you are using special characters in a url, you will need to URI encode them in order for us to interprete them correctly. For example, `+` should be encoded as `%2B` and though we accept `@`, they should still be encoded as `%40`. So filtering for email `user1+test@example.com`, you would use `/users?email=user1%2Btest%example.com` in your URI
Expandexpandlist
To expand multiple fields: `expand=role&expand=extra_fields`One or more of: role, extra_fields (Extra fields).
X organization idx_organization_idtext
Required if using a multi organizations token

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "users": []
  }
}

List work order comments

List work order comments.

Inputs

Work order IDwork_order_idtextRequired
The work order whose comments you want to read.
Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Comments returnedFrom 1 to 200. Default: 100.

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "comments": [],
    "nextCursor": "example",
    "nextPageUrl": "example"
  }
}

List work orders

List work orders.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Work Orders returnedFrom 1 to 200. Default: 100.
Titletitletext
To filter work orders by title
Assetsassetslist
To filter by multiple asset IDs: `assets=630&assets=634`
Not assetsnot_assetslist
Filter work orders that have none of the provided assets. To filter by multiple asset IDs: `notAssets=630&notAssets=634`
Locationslocationslist
To filter by multiple location IDs: `locations=193&locations=194&locations=195`
Not locationsnot_locationslist
Filter work orders that have none of the provided locations. To filter by multiple location IDs: `notLocations=193&notLocations=194&notLocations=195`
Partspartslist
To filter by multiple part IDs: `parts=14677&parts=14687`
Not partsnot_partslist
Filter work orders that have none of the provided parts. To filter by multiple part IDs: `notParts=14677&notParts=14687`
Vendorsvendorslist
To filter by multiple vendor IDs: `vendors=7123&vendors=2234`
Not vendorsnot_vendorslist
Filter work orders that have none of the provided vendors. To filter by multiple vendor IDs: `notVendors=7123&notVendors=2234`
Assigneesassigneeslist
To filter by multiple assignee IDs: `assignees=23494&assignees=79808`
Teamsteamslist
To filter by multiple team IDs: `teams=112&teams=243`
Categoriescategorieslist
To filter by multiple categories: `categories=123456&categories=Damage`
Not categoriesnot_categorieslist
Filter work orders that have none of the provided categories. To filter by multiple categories: `notCategories=123456&notCategories=Damage`
Prioritiesprioritieslist
To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`One or more of: NONE, LOW, MEDIUM, HIGH.
Statusesstatuseslist
To filter by multiple statuses: `statuses=IN_PROGRESS&statuses=DONE`One or more of: OPEN, IN_PROGRESS (In progress), ON_HOLD (On hold), DONE, CANCELED, SKIPPED.
Part statusespart_statuseslist
To filter by multiple partStatuses: `partStatuses=ASSIGNED&partStatuses=ISSUED`One or more of: NO_PARTS (No parts), ASSIGNED, RESERVED, KITTED, STAGED, ISSUED.
Parent sub work order typesparent_sub_work_order_typeslist
To filter by multiple parentSubWorkOrderTypes: `parentSubWorkOrderTypes=PARENT&parentSubWorkOrderTypes=SUB_WORK_ORDER`One or more of: PARENT, SUB_WORK_ORDER (Sub work order), STANDALONE.
Show upcomingshow_upcomingtrue/false
Include work orders with a future start date
Updated at gteupdated_at_gtedate and time
Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).
Updated at lteupdated_at_ltedate and time
Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).
Created at gtecreated_at_gtedate and time
Return records whose createdAt is at or after this ISO 8601 date-time (UTC).
Created at ltecreated_at_ltedate and time
Return records whose createdAt is at or before this ISO 8601 date-time (UTC).
Sortsorttext
Attribute on which to sort the list. (for descending order, prefix attribute with '-').One of: updatedAt, createdAt, dueDate, startedAt, completedAt, -updatedAt, -createdAt, -dueDate, -startedAt, -completedAt.
Expandexpandlist
To expand multiple fields: `expand=thumbnail&expand=assignees`One or more of: thumbnail, assignees, categories, parts, asset, location, procedure, team_ids (Team ids), vendor_ids (Vendor ids), times, and 7 more.
X organization idx_organization_idtext
Required if using a multi organizations token

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "workOrders": []
  }
}

List work requests

List work requests.

Inputs

Cursorcursortext
Last pagination reference
Limitlimitnumber
max number of Work Requests returnedFrom 1 to 200. Default: 100.
Titletitletext
To filter work orders by title or sequential ID
Assetsassetslist
To filter by multiple asset IDs: `assets=630&assets=634`
Locationslocationslist
To filter by multiple location IDs: `locations=193&locations=194&locations=195`
Prioritiesprioritieslist
To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`One or more of: NONE, LOW, MEDIUM, HIGH.
Statusesstatuseslist
To filter by multiple statuses: `statuses=APPROVED&statuses=DONE`One or more of: PENDING, REJECTED, APPROVED, DONE.
Expandexpandlist
To expand multiple fields: `expand=asset&expand=location`One or more of: asset, location, work_order (Work order), extra_fields (Extra fields).
X organization idx_organization_idtext
Required if using a multi organizations token

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "workRequests": []
  }
}

Set work order status

Update work order status.

Inputs

Work order IDidtextRequired
ID of the workOrder
Skip webhookskip_webhooktrue/false
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)
StatusstatustextRequired
Note: It is also possible to register a webhook to get notified when the status of any work order changes. Please see the Subscriptions section for more information.One of: OPEN, IN_PROGRESS (In progress), ON_HOLD (On hold), DONE, CANCELED.

Outputs

dataobject
Work order information
Example output
{
  "data": {
    "workOrder": {
      "assetId": 1,
      "assigneeIds": [],
      "attachments": [],
      "categories": [],
      "completedAt": "example",
      "completerId": 1,
      "createdAt": "example",
      "creatorId": 1,
      "customerId": 1,
      "deletedAt": "example",
      "description": "example",
      "dueDate": "example",
      "dueDateIsFullDay": false,
      "estimatedTime": 1,
      "externalData": {},
      "externalId": "example",
      "extraFields": {},
      "id": 1,
      "isParent": false,
      "lastMessageSentAt": "example",
      "locationId": 1,
      "nextId": 1,
      "organizationId": 1.0,
      "parentId": 1,
      "partStatus": "NO_PARTS",
      "partsAvailability": "PARTS_AVAILABLE",
      "previousId": 1,
      "priority": "NONE",
      "procedure": {
        "fields": [],
        "id": 1.0,
        "maxScore": 1.0,
        "score": 1.0,
        "templateIds": [],
        "title": "example"
      },
      "progress": {
        "doneCount": 1.0,
        "inProgressCount": 1.0,
        "onHoldCount": 1.0,
        "openCount": 1.0
      },
      "recurrenceInfo": {},
      "requesterId": 1,
      "sequentialId": 1,
      "startDate": "example",
      "status": "OPEN",
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "title": "example",
      "type": "CYCLE_COUNT",
      "updatedAt": "example",
      "vendorIds": [],
      "workOrderSummary": {
        "authorId": 1,
        "content": "example",
        "summary": "example"
      }
    }
  }
}

Update asset

Update asset.

Inputs

Asset IDidtextRequired
ID of the asset
Skip webhookskip_webhooktrue/false
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)
Namenametext
Name.
Descriptiondescriptiontext
Description.
Barcodebarcodetext
String encoded barcode
Criticality idcriticality_idtext
ID of the criticality of the asset
Parent idparent_idtext
ID of the parent asset
Locationlocation_idtext
ID of the location where the asset is located
Team idsteam_idslist
List of teams responsible for the asset
Asset typesasset_typeslist
List of asset types
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "My Custom Field")
Vendor idsvendor_idslist
Vendor IDs
Serial numberserial_numbertext
Serial number of the asset
Depreciationdepreciationobject
Depreciation information of the asset
External idexternal_idtext
External ID for this asset, unique per organization.
Manufacturermanufacturerobject
Manufacturer information for the asset. Set to null to clear manufacturer and model.
Modelmodelobject
Model information for the asset. Set to null to clear model.

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "asset": {
      "assetTypes": [],
      "attachments": [],
      "barcode": "example",
      "childrenIds": [],
      "createdAt": "example",
      "creatorId": 1,
      "criticalityId": 1,
      "currentOwnerId": 1.0,
      "deletedAt": "example",
      "depreciation": {
        "accumulatedDepreciation": 1.0,
        "annualDepreciation": 1.0,
        "archivedAt": "example",
        "createdAt": "example",
        "currentBookValue": 1.0,
        "depreciationStartDate": "example",
        "id": 1.0,
        "purchaseDate": "example",
        "purchasePrice": 1.0,
        "salvageValue": 1.0,
        "usefulLifeYears": 1.0,
        "yearsDepreciated": 1.0
      },
      "description": "example",
      "externalId": "example",
      "extraFields": {},
      "globalUuid": "example",
      "id": 1,
      "locationId": 1,
      "manufacturer": "example",
      "model": "example",
      "name": "example",
      "parentId": 1,
      "serialNumber": "example",
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "updatedAt": "example",
      "vendorIds": []
    }
  }
}

Update location

Update location.

Inputs

Location IDidtextRequired
ID of the location
Skip webhookskip_webhooktrue/false
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)
Namenametext
Name.
Descriptiondescriptiontext
Description.
Addressaddresstext
Postal address of the location
Barcodebarcodetext
String encoded barcode
Parent idparent_idtext
ID of the parent location
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")
Vendor idsvendor_idslist
Vendor IDs
External idexternal_idtext
External ID for this location, unique per organization.

Outputs

dataobject
Maintain X response data.
Example output
{
  "data": {
    "location": {
      "address": "example",
      "attachments": [],
      "barcode": "example",
      "childrenIds": [],
      "createdAt": "example",
      "deletedAt": "example",
      "description": "example",
      "externalId": "example",
      "extraFields": {},
      "id": 1,
      "name": "example",
      "parentId": 1,
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "updatedAt": "example",
      "vendorIds": []
    }
  }
}

Update work order

Update work order.

Inputs

Expandexpandlist
To expand multiple fields: `expand=assignees&expand=asset`One or more of: assignees, asset, estimated_time (Estimated time), location, parts, times, time_items (Time items), expenditures, extra_fields (Extra fields).
Work order IDidtextRequired
ID of the work order
Skip webhookskip_webhooktrue/false
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)
Assetasset_idtext
Asset id.
Assigneesassigneeslist
Either the teamId, the userId or the user email address
Requesterrequester_idtext
ID or email of the user who requested the work order
Categoriescategorieslist
List of categories that identify the work order
Descriptiondescriptiontext
Description.
Due datedue_datedate and time
Date & time at which the work order is due
Estimated timeestimated_timenumber
The estimated time taken in seconds to complete the work order
External dataexternal_dataobject
Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
External idexternal_idtext
External ID for this work order, unique per organization.
Start datestart_datedate and time
Date & time at which the work order will show up in the inboxOnly valid when dueDate is set
Locationlocation_idtext
Global ID of the location assigned to the work order
Priorityprioritytext
Priority.One of: NONE, LOW, MEDIUM, HIGH.
Procedureprocedureobject
Procedure.
Procedure templateprocedure_template_idnumber
ID of the procedure template to attach
Recurrence inforecurrence_infoobject
Recurrence info.
Titletitletext
Title.
Typetypetext
Valid types of Work Orders.One of: OTHER, REACTIVE, PREVENTIVE.
Extra fieldsextra_fieldsobject
Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Estimated Time Allotted")
Vendor idsvendor_idslist
Vendor IDs
Parts usedparts_usedlist
Parts IDs and quantities used in this work order

Outputs

dataobject
Work order information
Example output
{
  "data": {
    "workOrder": {
      "assetId": 1,
      "assigneeIds": [],
      "attachments": [],
      "categories": [],
      "completedAt": "example",
      "completerId": 1,
      "createdAt": "example",
      "creatorId": 1,
      "customerId": 1,
      "deletedAt": "example",
      "description": "example",
      "dueDate": "example",
      "dueDateIsFullDay": false,
      "estimatedTime": 1,
      "externalData": {},
      "externalId": "example",
      "extraFields": {},
      "id": 1,
      "isParent": false,
      "lastMessageSentAt": "example",
      "locationId": 1,
      "nextId": 1,
      "organizationId": 1.0,
      "parentId": 1,
      "partStatus": "NO_PARTS",
      "partsAvailability": "PARTS_AVAILABLE",
      "previousId": 1,
      "priority": "NONE",
      "procedure": {
        "fields": [],
        "id": 1.0,
        "maxScore": 1.0,
        "score": 1.0,
        "templateIds": [],
        "title": "example"
      },
      "progress": {
        "doneCount": 1.0,
        "inProgressCount": 1.0,
        "onHoldCount": 1.0,
        "openCount": 1.0
      },
      "recurrenceInfo": {},
      "requesterId": 1,
      "sequentialId": 1,
      "startDate": "example",
      "status": "OPEN",
      "teamIds": [],
      "thumbnail": {
        "createdAt": "example",
        "fileName": "example",
        "height": 1.0,
        "id": 1.0,
        "mimeType": "example",
        "url": "example",
        "width": 1.0
      },
      "title": "example",
      "type": "CYCLE_COUNT",
      "updatedAt": "example",
      "vendorIds": [],
      "workOrderSummary": {
        "authorId": 1,
        "content": "example",
        "summary": "example"
      }
    }
  }
}

On this page