# Johnson Controls Audits API

**Canonical:** https://apis.io/apis/johnson-controls/johnson-controls-audits-api/  
**Provider:** Johnson Controls — https://apis.io/providers/johnson-controls/  
**Base URL:** https://{hostname}/api/v6  
**Documentation:** https://jci-metasys.github.io/api-landing/

Johnson Controls Audits API is one of 11 APIs that [Johnson Controls](https://apis.io/providers/johnson-controls/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Audit. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a changelog, and 6 JSON Schemas.

How to retrieve, discard, and annotate audits. ### Relationships Audits have relationships to other resources in the system. Find information about the most important below. - **objects** When users or the system affect objects in the Metasys system, such as analog inputs, multistate objects, or binary outputs, audits are generated. Those "acted upon" objects then relate to those audits. That relationship is returned as part of any audit response. - **equipment instances** Equipment instance associations to audits build off of the objects association explanation. Each equipment instance can contain many points, such as Outdoor Air Temperature, Damper Position, or Zone Setpoint. Those points map to actual objects in Metasys, as noted above. When users or the system affect those objects, audits are generated. If an equipment instance's point is mapped to one of those affected objects the instance is then associated with that audit. In short, an equipment instance contains points which map to Metasys objects which are affected by an audited action. - **spaces** Space associations to audits build off of the equipment instance association explanation. Equipment instances can serve spaces, such as an Air Handler Unit (AHU) serving the floor of a building. Therefore, audits associated with a particular equipment instance are associated to the spaces they serve.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/objects/{objectId}/audits` | Get audits for an object |
| GET | `/audits/{auditId}` | Get an audit |
| PATCH | `/audits/{auditId}` | Edit an audit |
| GET | `/audits/{auditId}/annotations` | Get audit annotations |
| POST | `/audits/{auditId}/annotations` | Add audit annotation |
| GET | `/audits/users` | List audit users |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/openapi/johnson-controls-audits-api-openapi.yml
- **Documentation** — https://jci-metasys.github.io/api-landing/
- **GettingStarted** — https://jci-metasys.github.io/api-landing/guides/quickstart
- **ChangeLog** — https://jci-metasys.github.io/api-landing/guides/api-changelog
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/json-schema/johnson-controls-activities-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/json-schema/johnson-controls-alarm-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/json-schema/johnson-controls-network-device-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/json-schema/johnson-controls-audit-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/json-schema/johnson-controls-equipment-item-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/johnson-controls/refs/heads/main/json-schema/johnson-controls-equipment-points-schema.json

## Other Johnson Controls APIs (10)

- [Johnson Controls Activities API](https://apis.io/apis/johnson-controls/johnson-controls-activities-api/)
- [Johnson Controls Alarms API](https://apis.io/apis/johnson-controls/johnson-controls-alarms-api/)
- [Johnson Controls Authentication API](https://apis.io/apis/johnson-controls/johnson-controls-authentication-api/)
- [Johnson Controls Equipment API](https://apis.io/apis/johnson-controls/johnson-controls-equipment-api/)
- [Johnson Controls network devices API](https://apis.io/apis/johnson-controls/johnson-controls-network-devices-api/)
- [Johnson Controls Objects API](https://apis.io/apis/johnson-controls/johnson-controls-objects-api/)
- [Johnson Controls Schemas API](https://apis.io/apis/johnson-controls/johnson-controls-schemas-api/)
- [Johnson Controls Spaces API](https://apis.io/apis/johnson-controls/johnson-controls-spaces-api/)
- [Johnson Controls Streaming API](https://apis.io/apis/johnson-controls/johnson-controls-streaming-api/)
- [Johnson Controls time series API](https://apis.io/apis/johnson-controls/johnson-controls-time-series-api/)

## Tags

Audit

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/johnson-controls/johnson-controls-audits-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/johnson-controls/.