How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Green Button Alliance DataCustodian Integration API

Integration with OpenESPI DataCustodian

Green Button Alliance DataCustodian Integration API is one of 9 APIs that Green Button Alliance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DataCustodian Integration. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://authorization.greenbuttonalliance.org, https://staging-authorization.greenbuttonalliance.org.

4 operations 4 paths 8 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://sandbox.greenbuttonalliance.org:8443/DataCustodian
Authentication
HTTP Bearer, HTTP Basic, Mutual TLS
License
Terms of Service
Resource Areas
1

Authentication & Security 3

Green Button Alliance DataCustodian Integration API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (ClientCredentials). It requires mutual TLS (ClientCertificate). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

DataCustodian Integration 4

Integration with OpenESPI DataCustodian

POST
/api/v1/datacustodian/verify-user
Verify user credentials
body → 200400401502
GET
/api/v1/datacustodian/customers/{customerId}
Get retail customer info
1 param → 200401404502
GET
/api/v1/datacustodian/customers/{customerId}/usage-points
Get customer usage points
1 param → 200401404502
GET
/api/v1/datacustodian/health
DataCustodian health check
→ 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are RetailCustomerResponse (10 properties), UsagePoint (8 properties), ErrorResponse (6 properties), HealthResponse (6 properties). Each schema is shown below with its type and property counts.

HealthResponse
object
6 properties
HealthMetrics
object
4 properties
UsagePoint
object
8 properties
VerifyUserRequest
object
2 properties 2 required
UsagePointsResponse
object
2 properties
VerifyUserResponse
object
4 properties
ErrorResponse
object
6 properties
RetailCustomerResponse
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

green-button-alliance-datacustodian-integration-api-openapi.yml Raw ↑

Other APIs Green Button Alliance publishes across the network.

Green Button Third Party (OpenESPI) API
Green Button Alliance Application Information API
Green Button Alliance Authorization API
Green Button Alliance Batch API
Green Button Alliance OAuth2 Client Management API
Green Button Alliance OAuth2 Standard API
Green Button Alliance OIDC API
Green Button Alliance Usage Point API
Where this information came from

This is an independent, third-party profile of Green Button Alliance DataCustodian Integration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.