Guidewheel REST API v1

aid: guidewheel:rest-api-v1
name: Guidewheel REST API v1
description: REST over HTTPS with JSON request/response (CSV supported on specific bulk-load endpoints)
  for integrating Guidewheel with external ERP, MES and CMMS systems. Covers devices and equipment details,
  minute-level telemetry, uptime, load/run states, energy consumption, threshold-change history, issues
  (downtime events) with comments and tags, production entries including bulk upload, SKUs, tags, device
  lists, plants, shifts and scrap. All endpoints require a company-scoped API key in the x-api-key request
  header.
humanURL: https://support.guidewheel.app/en/articles/15696169-guidewheel-api-cmms-erp-integration-guide
baseURL: https://app.guidewheel.app/api/v1
x-base-url-note: Production base URL is tenant-specific and provided with credentials; a sandbox base
  URL is provided on request. The documented request form is https://<base-url>/api/v1/<resource>. app.guidewheel.app
  is the reachable Guidewheel production platform host; the /api/v1 path is not served anonymously from
  it (404 without tenant routing / credentials).
tags:
- Manufacturing
- Machine Monitoring
- OEE
- Telemetry
- Energy
properties:
- type: APIReference
  url: https://support.guidewheel.app/en/articles/15696169-guidewheel-api-cmms-erp-integration-guide
- type: Documentation
  url: https://support.guidewheel.app/en/articles/6732403-api-integrate-with-guidewheel
- type: Authentication
  url: authentication/guidewheel-authentication.yml
- type: RateLimits
  url: rate-limits/guidewheel-rate-limits.yml
- type: ErrorCatalog
  url: errors/guidewheel-problem-types.yml
- type: Conventions
  url: conventions/guidewheel-conventions.yml
- type: DataModel
  url: data-model/guidewheel-data-model.yml
- type: Sandbox
  url: sandbox/guidewheel-sandbox.yml