# MaintainX

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/maintainx

## Actions

### Create asset

Create new asset.

**Inputs**

- Skip webhook (`skip_webhook`, true/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 id (`x_organization_id`, text): Required if using a multi organizations token
- Name (`name`, text, required): Name.
- Description (`description`, text): Description.
- Barcode (`barcode`, text): String encoded barcode
- Criticality id (`criticality_id`, text): ID of the criticality of the asset
- Parent id (`parent_id`, text): ID of the parent asset
- Location (`location_id`, text): ID of the location where the asset is located
- Team ids (`team_ids`, list): List of teams responsible for the asset
- Asset types (`asset_types`, list): List of asset types
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "My Custom Field")
- Vendor ids (`vendor_ids`, list): Vendor IDs
- Serial number (`serial_number`, text): Serial number of the asset
- Depreciation (`depreciation`, object): Depreciation information of the asset
- External id (`external_id`, text): External ID for this asset, unique per organization.
- Manufacturer (`manufacturer`, object): Manufacturer information for the asset. Set to null to clear manufacturer and model.
- Model (`model`, object): Model information for the asset. Set to null to clear model.

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "id": 1
  }
}
```

### Create location

Create new location.

**Inputs**

- Skip webhook (`skip_webhook`, true/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 id (`x_organization_id`, text): Required if using a multi organizations token
- Name (`name`, text, required): Name.
- Description (`description`, text): Description.
- Address (`address`, text): Postal address of the location
- Barcode (`barcode`, text): String encoded barcode
- Parent id (`parent_id`, text): ID of the parent location
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")
- Vendor ids (`vendor_ids`, list): Vendor IDs
- External id (`external_id`, text): External ID for this location, unique per organization.

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "id": 1
  }
}
```

### Create work order

Create new work order.

**Inputs**

- Skip webhook (`skip_webhook`, true/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 id (`x_organization_id`, text): Required if using a multi organizations token
- Asset (`asset_id`, text): Asset id.
- Assignees (`assignees`, list): Either the teamId, the userId or the user email address
- Estimated time (`estimated_time`, number): The estimated time taken in seconds to complete the work order
- Requester (`requester_id`, text): ID or email of the user who requested the work order
- Work request id (`work_request_id`, text): ID of the Work Request that will be approved by the creation of this work order
- Work order template id (`work_order_template_id`, text): 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.
- Categories (`categories`, list): List of categories that identify the work order
- Description (`description`, text): Description.
- Due date (`due_date`, date and time): Date & time at which the work order is due
- External data (`external_data`, object): Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
- External id (`external_id`, text): External ID for this work order, unique per organization.
- Is parent (`is_parent`, true/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 date (`start_date`, date and time): Date & time at which the work order will show up in the inboxOnly valid when dueDate is set
- Location (`location_id`, text): Global ID of the location assigned to the work order
- Priority (`priority`, text): Priority. One of: `NONE`, `LOW`, `MEDIUM`, `HIGH`.
- Procedure (`procedure`, object): Procedure.
- Procedure template (`procedure_template_id`, number): ID of the procedure template to attach
- Repeatability (`repeatability`, object): Repeatability.
- Skip rest hook (`skip_rest_hook`, true/false): When work order is created, will not trigger any rest hook that is subscribed
- Title (`title`, text, required): Title.
- Type (`type`, text): Valid types of Work Orders. One of: `OTHER`, `REACTIVE`, `PREVENTIVE`.
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Estimated Time Allotted")
- Vendor ids (`vendor_ids`, list): Vendor IDs
- Parts used (`parts_used`, list): Parts IDs and quantities used in this work order
- Parent id (`parent_id`, number): 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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "id": 1.0
  }
}
```

### Create work order comment

Create new comment on a work order.

**Inputs**

- Work order ID (`id`, text, required): Global ID of the work order
- Skip webhook (`skip_webhook`, true/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)
- Content (`content`, text, required): Content of the comment to post

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "id": 1.0
  }
}
```

### Create work request

Create work request.

**Inputs**

- Skip webhook (`skip_webhook`, true/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 id (`x_organization_id`, text): Required if using a multi organizations token
- Description (`description`, text): Description.
- Priority (`priority`, text): Priority. One of: `NONE`, `LOW`, `MEDIUM`, `HIGH`.
- Title (`title`, text, required): Title.
- Asset (`asset_id`, number): Asset id.
- Location (`location_id`, number): Location id.
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Request Type")
- Approver team id (`approver_team_id`, number): ID of the team that is reponsible for approving the request.
- Creator contact info (`creator_contact_info`, text): 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 id (`external_id`, text): External ID for this work request, unique per organization.

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "id": 1.0
  }
}
```

### Delete asset

Delete asset.

**Inputs**

- Asset ID (`id`, text, required): ID of the asset
- Skip webhook (`skip_webhook`, true/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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete location

Delete location.

**Inputs**

- Location ID (`id`, text, required): ID of the location
- Skip webhook (`skip_webhook`, true/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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete work order

Delete workOrder.

**Inputs**

- Work order ID (`id`, text, required): ID of the workOrder
- Skip webhook (`skip_webhook`, true/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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete work request

Delete workRequest.

**Inputs**

- Work request ID (`id`, text, required): ID of the workRequest
- Skip webhook (`skip_webhook`, true/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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {}
}
```

### Get asset

Get asset.

**Inputs**

- Asset ID (`id`, text, required): ID of the asset

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "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 ID (`id`, text, required): ID of the location

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "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 ID (`id`, text, required): ID of the workOrder
- Expand (`expand`, list): 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 id (`use_sequential_id`, true/false): Whether to use the sequential ID instead of the global ID

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "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 ID (`id`, text, required): ID of the workRequest
- Expand (`expand`, list): To expand multiple fields: `expand=asset&expand=location`. One or more of: `asset`, `location`, `work_order` (Work order), `extra_fields` (Extra fields).

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "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**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Assets returned. From 1 to 200. Default: `100`.
- Location (`location_id`, text): Will only show assets that are related to the location
- Manufacturer (`manufacturer`, list): Filter assets by their manufacturer name
- Model (`model`, list): Filter assets by their manufacturer model name
- Updated at gte (`updated_at_gte`, date and time): Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).
- Updated at lte (`updated_at_lte`, date and time): Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).
- Created at gte (`created_at_gte`, date and time): Return records whose createdAt is at or after this ISO 8601 date-time (UTC).
- Created at lte (`created_at_lte`, date and time): Return records whose createdAt is at or before this ISO 8601 date-time (UTC).
- Custom field name (`custom_field_name`, list): 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.
- Sort (`sort`, text): Attribute on which to sort the list. (for descending order, prefix attribute with '-'). One of: `id`, `createdAt`, `updatedAt`, `-id`, `-createdAt`, `-updatedAt`.
- Expand (`expand`, list): 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 id (`x_organization_id`, text): Required if using a multi organizations token
- X organization ids (`x_organization_ids`, text): 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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "assets": [],
    "nextCursor": "example",
    "nextPageUrl": "example"
  }
}
```

### List locations

List locations.

**Inputs**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Locations returned. From 1 to 200. Default: `100`.
- Name (`name`, text): Will only show locations that have a name starting with this.
- Custom field name (`custom_field_name`, list): 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.
- Expand (`expand`, list): 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 id (`x_organization_id`, text): Required if using a multi organizations token
- X organization ids (`x_organization_ids`, text): 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**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "locations": [],
    "nextCursor": "example",
    "nextPageUrl": "example"
  }
}
```

### List procedure templates

List procedure templates.

**Inputs**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Procedure Templates returned. From 1 to 200. Default: `100`.
- Expand (`expand`, list): Expand. One or more of: `rows`.
- X organization id (`x_organization_id`, text): Required if using a multi organizations token

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "procedureTemplates": []
  }
}
```

### List teams

List teams.

**Inputs**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Teams returned. From 1 to 200. Default: `100`.
- X organization id (`x_organization_id`, text): Required if using a multi organizations token

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "teams": []
  }
}
```

### List users

List users.

**Inputs**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Users returned. From 1 to 200. Default: `100`.
- Only assignable (`only_assignable`, true/false): Will only show users that can be assigned to a work order
- Email (`email`, list): 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
- Expand (`expand`, list): To expand multiple fields: `expand=role&expand=extra_fields`. One or more of: `role`, `extra_fields` (Extra fields).
- X organization id (`x_organization_id`, text): Required if using a multi organizations token

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "users": []
  }
}
```

### List work order comments

List work order comments.

**Inputs**

- Work order ID (`work_order_id`, text, required): The work order whose comments you want to read.
- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Comments returned. From 1 to 200. Default: `100`.

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "comments": [],
    "nextCursor": "example",
    "nextPageUrl": "example"
  }
}
```

### List work orders

List work orders.

**Inputs**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Work Orders returned. From 1 to 200. Default: `100`.
- Title (`title`, text): To filter work orders by title
- Assets (`assets`, list): To filter by multiple asset IDs: `assets=630&assets=634`
- Not assets (`not_assets`, list): Filter work orders that have none of the provided assets. To filter by multiple asset IDs: `notAssets=630&notAssets=634`
- Locations (`locations`, list): To filter by multiple location IDs: `locations=193&locations=194&locations=195`
- Not locations (`not_locations`, list): Filter work orders that have none of the provided locations. To filter by multiple location IDs: `notLocations=193&notLocations=194&notLocations=195`
- Parts (`parts`, list): To filter by multiple part IDs: `parts=14677&parts=14687`
- Not parts (`not_parts`, list): Filter work orders that have none of the provided parts. To filter by multiple part IDs: `notParts=14677&notParts=14687`
- Vendors (`vendors`, list): To filter by multiple vendor IDs: `vendors=7123&vendors=2234`
- Not vendors (`not_vendors`, list): Filter work orders that have none of the provided vendors. To filter by multiple vendor IDs: `notVendors=7123&notVendors=2234`
- Assignees (`assignees`, list): To filter by multiple assignee IDs: `assignees=23494&assignees=79808`
- Teams (`teams`, list): To filter by multiple team IDs: `teams=112&teams=243`
- Categories (`categories`, list): To filter by multiple categories: `categories=123456&categories=Damage`
- Not categories (`not_categories`, list): Filter work orders that have none of the provided categories. To filter by multiple categories: `notCategories=123456&notCategories=Damage`
- Priorities (`priorities`, list): To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`. One or more of: `NONE`, `LOW`, `MEDIUM`, `HIGH`.
- Statuses (`statuses`, list): 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 statuses (`part_statuses`, list): 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 types (`parent_sub_work_order_types`, list): To filter by multiple parentSubWorkOrderTypes: `parentSubWorkOrderTypes=PARENT&parentSubWorkOrderTypes=SUB_WORK_ORDER`. One or more of: `PARENT`, `SUB_WORK_ORDER` (Sub work order), `STANDALONE`.
- Show upcoming (`show_upcoming`, true/false): Include work orders with a future start date
- Updated at gte (`updated_at_gte`, date and time): Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).
- Updated at lte (`updated_at_lte`, date and time): Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).
- Created at gte (`created_at_gte`, date and time): Return records whose createdAt is at or after this ISO 8601 date-time (UTC).
- Created at lte (`created_at_lte`, date and time): Return records whose createdAt is at or before this ISO 8601 date-time (UTC).
- Sort (`sort`, text): 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`.
- Expand (`expand`, list): 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 id (`x_organization_id`, text): Required if using a multi organizations token

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "workOrders": []
  }
}
```

### List work requests

List work requests.

**Inputs**

- Cursor (`cursor`, text): Last pagination reference
- Limit (`limit`, number): max number of Work Requests returned. From 1 to 200. Default: `100`.
- Title (`title`, text): To filter work orders by title or sequential ID
- Assets (`assets`, list): To filter by multiple asset IDs: `assets=630&assets=634`
- Locations (`locations`, list): To filter by multiple location IDs: `locations=193&locations=194&locations=195`
- Priorities (`priorities`, list): To filter by multiple priorities: `priorities=LOW&priorities=MEDIUM`. One or more of: `NONE`, `LOW`, `MEDIUM`, `HIGH`.
- Statuses (`statuses`, list): To filter by multiple statuses: `statuses=APPROVED&statuses=DONE`. One or more of: `PENDING`, `REJECTED`, `APPROVED`, `DONE`.
- Expand (`expand`, list): To expand multiple fields: `expand=asset&expand=location`. One or more of: `asset`, `location`, `work_order` (Work order), `extra_fields` (Extra fields).
- X organization id (`x_organization_id`, text): Required if using a multi organizations token

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "nextPageUrl": "example",
    "workRequests": []
  }
}
```

### Set work order status

Update work order status.

**Inputs**

- Work order ID (`id`, text, required): ID of the workOrder
- Skip webhook (`skip_webhook`, true/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)
- Status (`status`, text, required): 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**

- `data` (object): Work order information

**Example output**

```json
{
  "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 ID (`id`, text, required): ID of the asset
- Skip webhook (`skip_webhook`, true/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)
- Name (`name`, text): Name.
- Description (`description`, text): Description.
- Barcode (`barcode`, text): String encoded barcode
- Criticality id (`criticality_id`, text): ID of the criticality of the asset
- Parent id (`parent_id`, text): ID of the parent asset
- Location (`location_id`, text): ID of the location where the asset is located
- Team ids (`team_ids`, list): List of teams responsible for the asset
- Asset types (`asset_types`, list): List of asset types
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "My Custom Field")
- Vendor ids (`vendor_ids`, list): Vendor IDs
- Serial number (`serial_number`, text): Serial number of the asset
- Depreciation (`depreciation`, object): Depreciation information of the asset
- External id (`external_id`, text): External ID for this asset, unique per organization.
- Manufacturer (`manufacturer`, object): Manufacturer information for the asset. Set to null to clear manufacturer and model.
- Model (`model`, object): Model information for the asset. Set to null to clear model.

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "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 ID (`id`, text, required): ID of the location
- Skip webhook (`skip_webhook`, true/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)
- Name (`name`, text): Name.
- Description (`description`, text): Description.
- Address (`address`, text): Postal address of the location
- Barcode (`barcode`, text): String encoded barcode
- Parent id (`parent_id`, text): ID of the parent location
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")
- Vendor ids (`vendor_ids`, list): Vendor IDs
- External id (`external_id`, text): External ID for this location, unique per organization.

**Outputs**

- `data` (object): Maintain X response data.

**Example output**

```json
{
  "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**

- Expand (`expand`, list): 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 ID (`id`, text, required): ID of the work order
- Skip webhook (`skip_webhook`, true/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)
- Asset (`asset_id`, text): Asset id.
- Assignees (`assignees`, list): Either the teamId, the userId or the user email address
- Requester (`requester_id`, text): ID or email of the user who requested the work order
- Categories (`categories`, list): List of categories that identify the work order
- Description (`description`, text): Description.
- Due date (`due_date`, date and time): Date & time at which the work order is due
- Estimated time (`estimated_time`, number): The estimated time taken in seconds to complete the work order
- External data (`external_data`, object): Extra data that can be attached to the work order, for example to help reference to a matching record in an external system.
- External id (`external_id`, text): External ID for this work order, unique per organization.
- Start date (`start_date`, date and time): Date & time at which the work order will show up in the inboxOnly valid when dueDate is set
- Location (`location_id`, text): Global ID of the location assigned to the work order
- Priority (`priority`, text): Priority. One of: `NONE`, `LOW`, `MEDIUM`, `HIGH`.
- Procedure (`procedure`, object): Procedure.
- Procedure template (`procedure_template_id`, number): ID of the procedure template to attach
- Recurrence info (`recurrence_info`, object): Recurrence info.
- Title (`title`, text): Title.
- Type (`type`, text): Valid types of Work Orders. One of: `OTHER`, `REACTIVE`, `PREVENTIVE`.
- Extra fields (`extra_fields`, object): Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Estimated Time Allotted")
- Vendor ids (`vendor_ids`, list): Vendor IDs
- Parts used (`parts_used`, list): Parts IDs and quantities used in this work order

**Outputs**

- `data` (object): Work order information

**Example output**

```json
{
  "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"
      }
    }
  }
}
```
