Skip to content
Clayton Power API

Clayton Power External API

The External API gives you programmatic access to the Clayton Power systems your company owns: what they are, what they are doing right now, how much energy they have moved, and what has gone wrong.

It covers four areas:

  • Systems. List your systems and look one up by serial number.
  • Telemetry. The latest snapshot per system, plus energy and state-of-charge series over any period you have data for.
  • Alerts. Persistent alerts for offline systems, low state of charge, faults and critical health checks, with per-system thresholds you control.
  • Webhooks. Signed HTTP callbacks when an alert is raised or resolved, so you do not have to poll.

Base URL

Section titled “Base URL”
https://api.claytonpower.com/api/v1/external

Every endpoint in this documentation is relative to that base URL. Requests are authenticated with an API key sent in the X-API-Key header. There is no other authentication method: a session token from the Clayton Power apps is rejected.

Who can get a key

Section titled “Who can get a key”

API keys belong to a company, and a key can only ever see that company’s systems. Keys are created in fleet-manager under Settings -> API keys by a company administrator. If the card is not visible to you, ask an administrator of your company to create the key and send it to you securely.

A company can hold up to 20 active keys at a time.

Start here

Section titled “Start here”
  • Quickstart - create a key and make your first two requests.
  • Authentication and scopes - the header, the scope list and what 401 and 403 mean.
  • Concepts - serial numbers, product families, units, intervals and how fresh the numbers are. Read this before you build anything that draws a chart.
  • API reference - every endpoint, parameter and response field.

Stability

Section titled “Stability”

This is version 1. Additive changes (new endpoints, new fields on an existing response) can happen at any time and your integration must tolerate them. Breaking changes get a new version with at least six months of overlap. See Versioning and deprecation.

Support

Section titled “Support”

Write to platform@claytonpower.com. Include the correlationId from the error response when you report a problem with a specific request - it identifies the exact call in our logs. See Support.