# Virtual Peaker Group Management API

**Canonical:** https://apis.io/apis/virtual-peaker/virtual-peaker-group-management-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 Group Management 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. Tagged areas include Group Management. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, an engineering blog, and a getting-started guide.

Virtual Peaker supports managing groups of devices, in addition to individual device control. Grouping enables utilities to target clusters of devices together in demand response events.While device telemetry and configuration data is still reported on a per-device level, groups allow a single command to be broadcast to multiple enrolled devices simultaneously. To utilize grouping, the Device Partner integration must support both individual and group commands concurrently. The same device could receive an individual command, while also belonging to a group receiving a separate directive. Group commands have additional considerations: 1. Devices can opt out of group events individually, while the overall group command remains active. 2. Group command statuses reflect execution at the scheduling engine level rather than device state. 3. The Device Partner must reconcile group vs. individual state to ensure consistency in reporting. When not specified, all other workflows behave identically between individual and grouped devices - enrollment, data publishing, cancellations, etc.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| POST | `/group` | Create group |
| GET | `/group/{GROUP_ID}` | Read group details |
| PUT | `/group/{GROUP_ID}` | Update group details |
| DELETE | `/group/{GROUP_ID}` | Delete group |
| POST | `/group/{GROUP_ID}/devices` | Manage group devices |
| POST | `/command/{COMMAND_REFERENCE_ID}/opt-out` | Command Opt-Out |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/virtual-peaker/refs/heads/main/openapi/virtual-peaker-group-management-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 OAuth Device Discovery (Preferred) API](https://apis.io/apis/virtual-peaker/virtual-peaker-oauth-device-discovery-preferred-api/)
- [Virtual Peaker Pairing Code Device Discovery - End User App API](https://apis.io/apis/virtual-peaker/virtual-peaker-pairing-code-device-discovery-end-user-app-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/)

## Tags

Group Management

---

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