# Virtual Peaker Pairing Code Device Discovery - End User App API

**Canonical:** https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-end-user-app-api/  
**Provider:** Virtual Peaker — https://apis.io/providers/virtual-peaker/  
**Base URL:** https://partner.virtualpeaker.io/v1  
**Documentation:** https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html

Virtual Peaker Pairing Code Device Discovery - End User App API is one of 8 APIs that [Virtual Peaker](https://apis.io/providers/virtual-peaker/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, an engineering blog, and a getting-started guide.

The [pairing code](./device-partner-api.html#section/Pairing-Codes) device discovery flow works as follows: 1. The device owner fills out an onboarding form on Virtual Peaker's site. 2. At the end of the form, we provide them with a pairing code and instructions to enter it in the Device Partner's app. 3. Optionally, the user selects which devices to enroll via the Device Partner's interface. Otherwise, all devices are enrolled by default. 4. When the user enters the pairing code in the Device Partner's app, the Device Partner publishes a device enrollment event to Virtual Peaker's API. 5. The publish event includes the pairing code, allowing Virtual Peaker to link the device back to the onboarding form entry. 6. If multiple devices are enrolled, the same pairing code is used in each publish payload. 7. Virtual Peaker discovers the user details associated with the enrolled device(s). 8. We subscribe to the devices for data publishing and provide a `DEVICE_PUBLISH_SECRET`. The user experience is driven through the Device Partner's web or mobile app after receiving the pairing code. This links together the Virtual Peaker and Device Partner platforms.

## Operations (1)

| Method | Path | Summary |
|---|---|---|
| GET | `/device/{DEVICE_UID}/user` | Describe device's user |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/openapi/virtual-peaker-pairing-code-device-discovery-end-user-app-api-openapi.yml
- **APIReference** — https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html
- **Documentation** — https://virtual-peaker.com/partners/device-partners/
- **Blog** — https://virtual-peaker.com/blog/gravity-connect-api-oem-derms-integrations/
- **GettingStarted** — https://assets.virtualpeaker.io/gravity-connect/device-partner-api.html#section/Getting-Started
- **APIReference** — https://assets.virtualpeaker.io/gravity-connect/vp-api.html
- **Documentation** — https://virtual-peaker.com/apis/
- **Blog** — https://virtual-peaker.com/blog/gravity-connect-v-openadr/
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/asyncapi/virtual-peaker-gravity-connect-webhooks.yml

## Other Virtual Peaker APIs (7)

- [Virtual Peaker Commands API](https://apis.io/apis/virtual-peaker/virtual-peaker-commands-api/)
- [Virtual Peaker Devices API](https://apis.io/apis/virtual-peaker/virtual-peaker-devices-api/)
- [Virtual Peaker Energy Interval Endpoint API](https://apis.io/apis/virtual-peaker/virtual-peaker-energy-interval-endpoint-api/)
- [Virtual Peaker Group Management API](https://apis.io/apis/virtual-peaker/virtual-peaker-group-management-api/)
- [Virtual Peaker OAuth Device Discovery (Preferred) API](https://apis.io/apis/virtual-peaker/virtual-peaker-oauth-device-discovery-preferred-api/)
- [Virtual Peaker Pairing Code Device Discovery - Utility Commissioned Installation API](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-utility-commissioned-installation-api/)
- [Virtual Peaker Publishing API](https://apis.io/apis/virtual-peaker/virtual-peaker-publishing-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-end-user-app-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/virtual-peaker/.