Documentation

Copy page

Public Vendor Catalog

Read-only access to the supported vendor and model catalog. Use it to render a vendor/device picker or browse onboarding options. No userId is required.

TL;DR

• GET /v1/catalog/vendors → GET /v1/catalog/vendors/{vendorId} → GET /v1/catalog/vendors/{vendorId}/connection-options
• Authentication is optional. Send your Authorization: Bearer token to get the catalog scoped to your white-label app; call anonymously to get the default clever-PV catalog. No userId is needed either way.
• Connection-option placeholders are returned as readable documentation tokens (e.g. HOME_OCPP_ID) because there is no home/user to resolve them against. To actually onboard a device, switch to the authenticated Device Onboarding Flow.

---

Authentication (optional)

Call style	Catalog returned
Anonymous (no token)	The default clever-PV catalog.
Authenticated (Authorization: Bearer <token>, same token as the rest of the Connect API)	The catalog scoped to your partner's white-label app — i.e. exactly the vendors/models your app users can onboard.

Scoping applies to List Vendors and Get Vendor. If the token is missing or its app cannot be resolved, the response falls back to the default clever-PV catalog. Get Connection Options always returns documentation tokens regardless of authentication (see below).

---

List Vendors

Code
GET /v1/catalog/vendors?category={category}

Returns the clever-PV catalog when called anonymously, or your app-scoped catalog when authenticated.

category (query, optional) filters by device category. Values (camelCase): electricMeter | wallbox | switch | powerStorage | car | heatPump | heatingRod | dishwasher.

Response: paginated list of vendors.

Code
{
  "data": [
    {
      "id": "ae1b4468-217e-440d-a2c7-3c44d283a6c1",
      "identifier": "tesla",
      "name": "Tesla",
      "flow": "oidcProxy",
      "models": [
        { "id": "1ffc08b8-0319-4790-a7d9-0aa5a56fe34d", "name": "Model Y", "category": "car" }
      ]
    }
  ],
  "total": 1,
  "size": 1,
  "cursor": null,
  "hasMoreResults": false
}

Field	Notes
identifier	Stable machine-readable vendor key.
flow	Onboarding flow: form | oidcProxy | oidc | ocpp | push. See Device Onboarding Flow.
models[]	Supported device models, each with id, name and category.

---

Get Vendor

Code
GET /v1/catalog/vendors/{vendorId}

Returns a single vendor in the same shape as a data[] entry above, scoped the same way (anonymous → clever-PV catalog, authenticated → your app-scoped catalog). 404 Not Found if the vendor is not in the resolved catalog.

---

Get Connection Options

Code
GET /v1/catalog/vendors/{vendorId}/connection-options

Same response shape as the authenticated Step 2: Get Connection Options, but placeholders are replaced with documentation tokens instead of resolved per-home values. This endpoint is not app-scoped and returns the same documentation tokens whether or not you authenticate — there is no home/user on this route to resolve real values against.

Code
{
  "flow": "ocpp",
  "formOptions": [
    {
      "type": "text",
      "data": {
        "value": "wss://ocpp.clever-pv.com/HOME_OCPP_ID/DEVICE_TAG",
        "readonly": true,
        "label": "OCPP Connection URL"
      }
    }
  ],
  "docUrl": null
}

Note: Tokens like HOME_OCPP_ID or DEVICE_TAG are placeholders for documentation only. Real, resolved values are minted by the authenticated onboarding flow (POST /connections). 404 Not Found if the vendor is not in the catalog.