Servers Playground How we check Add a server Log in

UpKeep MCP by usefulapi

Working · 655 ms

io.usefulapi/upkeepv1.2.0 Domain verified

Read UpKeep work orders, assets, parts and meters; create requests and work orders.

Productivity

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://upkeep.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

upkeep_add_meter_reading Destructive

WRITE: record a new reading on a meter (for example engine hours or mileage). A reading cannot be removed with this server, and a meter notification can create a work order automatically when its condition is met. POST /meters/{id}/readings.

valuenumber, required

The reading value.

meter_idstring, required

UpKeep meter id (a short string such as "HW2I379ErS").

datestring

When the reading was taken (ISO 8601). Defaults to now.

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

UpKeep MCP by usefulapi MCP server | mcptry

Tools (29)

upkeep_add_meter_reading

destructive

Argument	Type	Description
date	string	When the reading was taken (ISO 8601). Defaults to now.
value*	number	The reading value.
meter_id*	string	UpKeep meter id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "meter_id",
    "value"
  ],
  "properties": {
    "date": {
      "type": "string",
      "description": "When the reading was taken (ISO 8601). Defaults to now."
    },
    "value": {
      "type": "number",
      "description": "The reading value."
    },
    "meter_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep meter id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_add_work_order_message

WRITE: post a message (comment) on a work order's activity thread; people following the work order may be notified. POST /work-orders/{id}/update-messages.

destructive

Argument	Type	Description
text*	string	The message text.
work_order_id*	string	UpKeep work order id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "work_order_id",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "The message text."
    },
    "work_order_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep work order id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_approve_request

WRITE: approve a pending work request, which converts it into a work order (it may notify the assignee). Needs a token whose role may approve requests. Approving a request that is already approved or declined fails with HTTP 409. POST /requests/{id}/approve.

destructive

Argument	Type	Description
request_id*	string	UpKeep request id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "request_id"
  ],
  "properties": {
    "request_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep request id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_create_request

WRITE: submit a new work request for the maintenance team to approve (it appears in UpKeep's Requests list and may notify the approvers or the assignee). It is not a work order until approved. If the account has a request form configured, pass its field labels in `fields`. POST /requests.

destructive

Argument	Type	Description
team	string	Team id.
asset	string	Asset id.
title*	string	Short title, e.g. Repair sink.
fields	array	Request form values: each name must match a field label on the account's request form.
category	string	Must be one of the account's configured categories.
due_date	string	Due date, ISO 8601.
location	string	Location id.
priority	integer	Priority: 0 none/lowest, 1 low, 2 medium, 3 high.
description	string

upkeep_create_work_order

WRITE: create a new work order (it may notify the assignee and appears in UpKeep's work order board). Ids for asset, location and assignee come from the list tools. POST /work-orders.

destructive

Argument	Type	Description
asset	string	Asset id.
title*	string	Short title, e.g. Repair sink.
category	string	Must be one of the account's configured work order categories.
due_date	string	Due date, ISO 8601.
location	string	Location id.
priority	integer	Priority: 0 none/lowest, 1 low, 2 medium, 3 high.
start_date	string	Start date, ISO 8601.
description	string
assigned_to_user	string	User id to assign.
estimated_duration_hours

upkeep_get_account

Confirm the UpKeep API token is active: returns the company id, the token's name, when it was created and when it was last used. GET /api/v1/organization-api-tokens/introspect.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

upkeep_get_asset

One asset by id with purchase and warranty details, custom fields and (optionally) assigned users, teams, vendors, parts, files and sub-assets. GET /assets/{id}.

read-only

Argument	Type	Description
asset_id*	string	UpKeep asset id (a short string such as "HW2I379ErS").
includes	array	Expand referenced records inline instead of returning ids. Allowed: assignedUsers, assignedTeams, assignedCustomers, assignedVendors, formItems, files, parts, subAssets, location, parentAsset, createdByUser, assignedToUser.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "asset_id"
  ],
  "properties": {
    "asset_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep asset id (a short string such as \"HW2I379ErS\")."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: assignedUsers, assignedTeams, assignedCustomers, assignedVendors, formItems, files, parts, subAssets, location, parentAsset, createdByUser, assignedToUser."
    }
  }
}

upkeep_get_location

One location by id. GET /locations/{id}.

read-only

Argument	Type	Description
location_id*	string	UpKeep location id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "location_id"
  ],
  "properties": {
    "location_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep location id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_get_meter

One meter by id. GET /meters/{id}.

read-only

Argument	Type	Description
meter_id*	string	UpKeep meter id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "meter_id"
  ],
  "properties": {
    "meter_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep meter id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_get_part

One part by id with quantity, cost, location and custom fields. GET /parts/{id}.

read-only

Argument	Type	Description
part_id*	string	UpKeep part id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "part_id"
  ],
  "properties": {
    "part_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep part id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_get_purchase_order

One purchase order by id with its parts, quantities, costs and shipping details. GET /purchase-orders/{id}.

read-only

Argument	Type	Description
purchase_order_id*	string	UpKeep purchase order id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "purchase_order_id"
  ],
  "properties": {
    "purchase_order_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep purchase order id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_get_request

One work request by id with its form fields and, once approved, the linked work order id. GET /requests/{id}.

read-only

Argument	Type	Description
request_id*	string	UpKeep request id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "request_id"
  ],
  "properties": {
    "request_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep request id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_get_user

One user by id. GET /users/{id}.

read-only

Argument	Type	Description
user_id*	string	UpKeep user id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep user id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_get_work_order

One work order by id with its checklist items, custom fields, time log, parts and files. GET /work-orders/{id}.

read-only

Argument	Type	Description
includes	array	Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team.
work_order_id*	string	UpKeep work order id (a short string such as "HW2I379ErS").

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "work_order_id"
  ],
  "properties": {
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team."
    },
    "work_order_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep work order id (a short string such as \"HW2I379ErS\")."
    }
  }
}

upkeep_list_assets

List assets (equipment) with name, model, serial and barcode, location, status, downtime status, warranty and number of open work orders. Filter by name, serial number, barcode, location, status, category or assignee. GET /assets.

read-only

Argument	Type	Description
name	string	Only assets with exactly this name.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
status	string	Only assets with this status (active or inactive).
barcode	string	Only the asset with this barcode number.
category	string	Only assets in this category.
includes	array	Expand referenced records inline instead of returning ids. Allowed: location, parentAsset, createdByUser, assignedToUser.
location	string	Only records for this location id.
order_by

upkeep_list_customers

List customers (the parties whose assets or locations you maintain) with contact details. GET /customers.

read-only

Argument	Type	Description
name	string	Only customers with exactly this name.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only customers with exactly this name."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    }
  }
}

upkeep_list_locations

List locations (sites, buildings, rooms) with address, barcode, parent location and hierarchy level. GET /locations.

read-only

Argument	Type	Description
name	string	Only locations with exactly this name.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
barcode	string	Only the location with this barcode.
includes	array	Expand referenced records inline instead of returning ids. Allowed: createdByUser, parentLocation, hierarchyLevel, ancestors, numTotalChildren, numTotalDescendants.
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt (default "createdAt DESC").
created_after	string	Created at or after this time. ISO 8601.
updated_after	string	Updated at or after this time. ISO 8601.
created_before

upkeep_list_meter_readings

Readings recorded for one meter (value, date, who recorded it), newest first. GET /meters/{id}/readings.

read-only

Argument	Type	Description
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
meter_id*	string	UpKeep meter id (a short string such as "HW2I379ErS").
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt (default "createdAt DESC").
read_after	string	Reading date at or after this time. ISO 8601.
read_before	string	Reading date at or before this time. ISO 8601.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "meter_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "meter_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep meter id (a short string such as \"HW2I379ErS\")."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\")."
    },
    "read_after": {
      "type": "string",
      "description": "Reading date at or after this time. ISO 8601."
    },
    "read_before": {
      "type": "string",
      "description": "Reading date at or before this time. ISO 8601."
    }
  }
}

upkeep_list_meters

List meters (usage counters such as hours, mileage, temperature) with units, reading frequency and the asset or location they belong to. GET /meters.

read-only

Argument	Type	Description
name	string	Only meters with exactly this name.
asset	string	Only records for this asset id.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
includes	array	Expand referenced records inline instead of returning ids. Allowed: asset, location, createdByUser.
location	string	Only records for this location id.
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt (default "createdAt DESC").
created_after	string	Created at or after this time. ISO 8601.
updated_after	string

upkeep_list_parts

List spare parts with quantity on hand, minimum quantity, cost, category, location and part number. Compare quantity with minimumQuantity to find parts to reorder. GET /parts.

read-only

Argument	Type	Description
name	string	Only parts with exactly this name.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
category	string	Only parts in this category.
includes	array	Expand referenced records inline instead of returning ids. Allowed: location, createdByUser.
location	string	Only records for this location id.
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt (default "createdAt DESC").
part_number	string	Only parts with this part number.
created_after	string

upkeep_list_preventive_maintenance

List preventive maintenance (PM) templates, the recurring work that generates scheduled work orders, with their schedules. Filter by text, asset, location, assignee, team or priority. Pages are 1-based. GET /pm.

read-only

Argument	Type	Description
page	integer	Page number from 1 (default 1).
team	string	Only records for this team id.
asset	string	Only records for this asset id.
search	string	Text to find in the PM's name or description.
assignee	string	Only records for this assigned user id.
location	string	Only records for this location id.
priority	integer	Priority: 0 none/lowest, 1 low, 2 medium, 3 high.
page_size	integer	PMs per page, 1-100 (default 25).
include_schedules	boolean	Also return each PM's schedules.

upkeep_list_purchase_orders

List purchase orders with status (awaiting, approved, declined, fulfilled), vendor, dates, total cost and quantities. GET /purchase-orders.

read-only

Argument	Type	Description
limit	integer	Records per page, 1-100 (default 25).
title	string	Only purchase orders with exactly this title.
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
status	string	Only purchase orders in this status.
vendor	string	Only records for this vendor id.
category	string	Only this purchase order category.
includes	array	Expand referenced records inline instead of returning ids. Allowed: vendor, createdByUser, approvedByUser, fulfilledByUser, declinedByUser.
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt, dueDate, poDate, fulfilledAt, approvedAt, declinedAt (default "createdAt DESC").

upkeep_list_requests

List work requests submitted by staff or through the request portal (before they become work orders), with status open/approved/rejected. GET /requests.

read-only

Argument	Type	Description
team	string	Only records for this team id.
asset	string	Only records for this asset id.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
category	string	Only this request category.
includes	array	Expand referenced records inline instead of returning ids. Allowed: asset, location, team, assignedToUser, assignedByUser, cancelledByUser.
location	string	Only records for this location id.
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt, dueDate, endDueDate (default "createdAt DESC").
created_after

upkeep_list_teams

List teams with name and description. Use the ids to assign work. GET /teams.

read-only

Argument	Type	Description
name	string	Only teams with exactly this name.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only teams with exactly this name."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    }
  }
}

upkeep_list_users

List UpKeep users (technicians, admins, requesters) with account type, job title, status and last login. Use the ids to assign work orders. GET /users.

read-only

Argument	Type	Description
email	string	Only the user with this email.
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
order_by	string	Sort: "<field> ASC\|DESC" with field one of createdAt, updatedAt (default "createdAt DESC").
account_type	string	Only users with this account type.
created_after	string	Created at or after this time. ISO 8601.
updated_after	string	Updated at or after this time. ISO 8601.
created_before	string	Created at or before this time. ISO 8601.
updated_before	string

upkeep_list_vendors

List vendors (suppliers and contractors) with contact details. GET /vendors.

read-only

Argument	Type	Description
limit	integer	Records per page, 1-100 (default 25).
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
business_name	string	Only vendors with exactly this business name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "business_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only vendors with exactly this business name."
    }
  }
}

upkeep_list_work_orders

List work orders (reactive and preventive), newest first, with status, priority, due date, asset, location, assignee, parts, time and cost. Filter by status, completion, priority, category, asset, location, assignee, title or date ranges. GET /work-orders.

read-only

Argument	Type	Description
asset	string	Only records for this asset id.
limit	integer	Records per page, 1-100 (default 25).
title	string	Only work orders with exactly this title.
offset	integer	Records to skip (default 0). Pass the previous reply's next_offset.
status	string	Only work orders in this status.
archived	boolean	true = only archived work orders.
category	string	Only this work order category (e.g. Electrical).
includes	array	Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team.

upkeep_update_part_quantity

WRITE: set the quantity on hand (and optionally the minimum quantity that triggers a low-stock notification) of a part. This overwrites the stored number: read the part first and pass the new total, not the difference. PATCH /parts/{id}.

destructive

Argument	Type	Description
part_id*	string	UpKeep part id (a short string such as "HW2I379ErS").
quantity*	number	The new quantity on hand (a total).
minimum_quantity	number	New low-stock threshold.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "part_id",
    "quantity"
  ],
  "properties": {
    "part_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep part id (a short string such as \"HW2I379ErS\")."
    },
    "quantity": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "The new quantity on hand (a total)."
    },
    "minimum_quantity": {
      "type": "number",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "New low-stock threshold."
    }
  }
}

upkeep_update_work_order

WRITE: change fields of an existing work order: status (open, onHold, inProgress, complete), title, description, priority, due date or assignee. Only the fields you pass change; completing a work order may trigger the account's integrations (for example Zapier). Archiving and deleting are not offered. PATCH /work-orders/{id}.

destructive

Argument	Type	Description
title	string
status	string
due_date	string	Due date, ISO 8601.
priority	integer	Priority: 0 none/lowest, 1 low, 2 medium, 3 high.
description	string
work_order_id*	string	UpKeep work order id (a short string such as "HW2I379ErS").
assigned_to_user	string	User id to assign.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "work_order_id"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 250,
      "minLength": 1
    },
    "status": {
      "enum": [
        "open",
        "onHold",
        "inProgress",
        "complete"
      ],
      "type": "string"
    },
    "due_date": {
      "type": "string",
      "description": "Due date, ISO 8601."
    },
    "priority": {
      "type": "integer",
      "maximum": 3,
      "minimum": 0,
      "description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
    },
    "description": {
      "type": "string",
      "maxLength": 5000
    },
    "work_order_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "UpKeep work order id (a short string such as \"HW2I379ErS\")."
    },
    "assigned_to_user": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "User id to assign."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only assets with exactly this name."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "status": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Only assets with this status (active or inactive)."
    },
    "barcode": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the asset with this barcode number."
    },
    "category": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only assets in this category."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: location, parentAsset, createdByUser, assignedToUser."
    },
    "location": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this location id."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\")."
    },
    "created_after": {
      "type": "string",
      "description": "Created at or after this time. ISO 8601."
    },
    "serial_number": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the asset with this serial number."
    },
    "updated_after": {
      "type": "string",
      "description": "Updated at or after this time. ISO 8601."
    },
    "created_before": {
      "type": "string",
      "description": "Created at or before this time. ISO 8601."
    },
    "updated_before": {
      "type": "string",
      "description": "Updated at or before this time. ISO 8601."
    },
    "downtime_status": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only assets with this downtime status id."
    },
    "assigned_to_user": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this assigned user id."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only locations with exactly this name."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "barcode": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the location with this barcode."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: createdByUser, parentLocation, hierarchyLevel, ancestors, numTotalChildren, numTotalDescendants."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\")."
    },
    "created_after": {
      "type": "string",
      "description": "Created at or after this time. ISO 8601."
    },
    "updated_after": {
      "type": "string",
      "description": "Updated at or after this time. ISO 8601."
    },
    "created_before": {
      "type": "string",
      "description": "Created at or before this time. ISO 8601."
    },
    "updated_before": {
      "type": "string",
      "description": "Updated at or before this time. ISO 8601."
    },
    "hierarchy_level": {
      "type": "integer",
      "maximum": 5,
      "minimum": 0,
      "description": "Only this hierarchy level (0 = top level, up to 5)."
    },
    "parent_location": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this parent location id."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only parts with exactly this name."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "category": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only parts in this category."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: location, createdByUser."
    },
    "location": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this location id."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\")."
    },
    "part_number": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only parts with this part number."
    },
    "created_after": {
      "type": "string",
      "description": "Created at or after this time. ISO 8601."
    },
    "updated_after": {
      "type": "string",
      "description": "Updated at or after this time. ISO 8601."
    },
    "created_before": {
      "type": "string",
      "description": "Created at or before this time. ISO 8601."
    },
    "updated_before": {
      "type": "string",
      "description": "Updated at or before this time. ISO 8601."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "title": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only purchase orders with exactly this title."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "status": {
      "enum": [
        "awaiting",
        "approved",
        "declined",
        "fulfilled"
      ],
      "type": "string",
      "description": "Only purchase orders in this status."
    },
    "vendor": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this vendor id."
    },
    "category": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this purchase order category."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: vendor, createdByUser, approvedByUser, fulfilledByUser, declinedByUser."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, poDate, fulfilledAt, approvedAt, declinedAt (default \"createdAt DESC\")."
    },
    "due_after": {
      "type": "string",
      "description": "Due at or after this time. ISO 8601."
    },
    "due_before": {
      "type": "string",
      "description": "Due at or before this time. ISO 8601."
    },
    "created_after": {
      "type": "string",
      "description": "Created at or after this time. ISO 8601."
    },
    "updated_after": {
      "type": "string",
      "description": "Updated at or after this time. ISO 8601."
    },
    "created_before": {
      "type": "string",
      "description": "Created at or before this time. ISO 8601."
    },
    "updated_before": {
      "type": "string",
      "description": "Updated at or before this time. ISO 8601."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "team": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this team id."
    },
    "asset": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this asset id."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "category": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this request category."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, team, assignedToUser, assignedByUser, cancelledByUser."
    },
    "location": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this location id."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, endDueDate (default \"createdAt DESC\")."
    },
    "created_after": {
      "type": "string",
      "description": "Created at or after this time. ISO 8601."
    },
    "updated_after": {
      "type": "string",
      "description": "Updated at or after this time. ISO 8601."
    },
    "created_before": {
      "type": "string",
      "description": "Created at or before this time. ISO 8601."
    },
    "request_status": {
      "enum": [
        "requested",
        "declined",
        "approved"
      ],
      "type": "string",
      "description": "Only requests in this state."
    },
    "updated_before": {
      "type": "string",
      "description": "Updated at or before this time. ISO 8601."
    },
    "assigned_to_user": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this assigned user id."
    },
    "requested_by_user": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this requesting user id."
    },
    "public_requester_email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Only requests sent by this email through the request portal."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "asset": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this asset id."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Records per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "title": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only work orders with exactly this title."
    },
    "offset": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Records to skip (default 0). Pass the previous reply's next_offset."
    },
    "status": {
      "enum": [
        "open",
        "onHold",
        "inProgress",
        "complete"
      ],
      "type": "string",
      "description": "Only work orders in this status."
    },
    "archived": {
      "type": "boolean",
      "description": "true = only archived work orders."
    },
    "category": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only this work order category (e.g. Electrical)."
    },
    "includes": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z.]+$",
        "maxLength": 60
      },
      "maxItems": 12,
      "description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team."
    },
    "location": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this location id."
    },
    "order_by": {
      "type": "string",
      "pattern": "^[A-Za-z]+ (ASC|DESC)$",
      "description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, endDueDate, dateCompleted (default \"createdAt DESC\")."
    },
    "priority": {
      "type": "integer",
      "maximum": 3,
      "minimum": 0,
      "description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
    },
    "due_after": {
      "type": "string",
      "description": "Due at or after this time. ISO 8601."
    },
    "due_before": {
      "type": "string",
      "description": "Due at or before this time. ISO 8601."
    },
    "is_complete": {
      "type": "boolean",
      "description": "true = only completed work orders, false = only not yet completed."
    },
    "created_after": {
      "type": "string",
      "description": "Created at or after this time. ISO 8601."
    },
    "updated_after": {
      "type": "string",
      "description": "Updated at or after this time. ISO 8601."
    },
    "created_before": {
      "type": "string",
      "description": "Created at or before this time. ISO 8601."
    },
    "updated_before": {
      "type": "string",
      "description": "Updated at or before this time. ISO 8601."
    },
    "completed_after": {
      "type": "string",
      "description": "Completed at or after this time. ISO 8601."
    },
    "assigned_by_user": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this assigning user id."
    },
    "assigned_to_user": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only records for this assigned user id."
    },
    "completed_before": {
      "type": "string",
      "description": "Completed at or before this time. ISO 8601."
    },
    "public_requester_email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Only work orders created by this email through the request portal."
    }
  }
}