How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UpKeep Work Orders API

Work order creation and management

UpKeep Work Orders API is one of 10 APIs that UpKeep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Work Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2022-09-14.

Requests are made against a single base URL, https://api.onupkeep.com/api/v2.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2022-09-14
Base URL
https://api.onupkeep.com/api/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

UpKeep Work Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as session-token (SessionToken). By default, every request must be authenticated.

  • SessionToken — Session token obtained from POST /auth

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Work Orders 5

Work order creation and management

GET
/work-orders
List Work Orders
listWorkOrders 6 params → 200401
POST
/work-orders
Create Work Order
createWorkOrder body → 200400401
GET
/work-orders/{id}
Get Work Order
getWorkOrder 2 params → 200401404
PATCH
/work-orders/{id}
Update Work Order
updateWorkOrder 1 param body → 200400401404
DELETE
/work-orders/{id}
Delete Work Order
deleteWorkOrder 1 param → 204401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WorkOrder (15 properties), WorkOrderRequest (9 properties), WorkOrderList (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.

WorkOrder
object
15 properties
WorkOrderRequest
object
9 properties 1 required
Error
object
2 properties
WorkOrderList
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upkeep-work-orders-api-openapi.yml Raw ↑

Other APIs UpKeep publishes across the network.

UpKeep Assets API
UpKeep Authentication API
UpKeep Locations API
UpKeep Meters API
UpKeep Parts API
UpKeep Preventive Maintenance API
UpKeep Purchase Orders API
UpKeep Requests API
UpKeep Webhooks API
Where this information came from

This is an independent, third-party profile of UpKeep Work Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.