Forms

Get Form Fields

Returns the fields required to submit an offer enrollment for the given offer_id. The field schema varies by offer — pass the offer_id from the offers endpoint and use the returned fields to construct the POST /form request body.

Conditional Field Schemas

dependent_key / dependent_value (conditional fields)

Used by any offer whose form has conditional fields, such as EV charger installation. A field with dependent_key and dependent_value is only shown (and required) when the referenced sibling field equals the given value.

someField:
  dependent_key: otherField     # watch this field
  dependent_value: someValue    # show me when it equals this

cascading_group (chained dropdowns)

A field with cascading_group participates in a multi-level chained dropdown. Each level filters the options of the next level based on the selected value.

PropertyMeaning
groupLogical group name — fields sharing a group are chained
levelPosition in the chain (1 = root, 2 = first child, …)
parentKey of the field whose selected value selects options here
options_mapMap from parent value → array of valid options for this field

Important difference from dependent_key:

  • dependent_key hides/shows a field based on a binary condition (show or hide).
  • cascading_group narrows the allowed options of a field based on the parent selection. The field is always visible; its option list changes dynamically.

Vehicle selection cascade: Three chained levels: vehicleMake (level 1) → vehicleModel (level 2) → vehicleYear (level 3). Makes and models are sorted alphabetically; years are sorted newest-first.

get/form

Request

  • Base URL
    https://apis.wattbuy.com/v3
  • Auth
    API key in header x-api-key

Query parameters

offer_idstring required

The unique identifier for the offer. This was previously referred to as plan_id.

Response

OK

requiredLoaboolean

Example response

{
  "supplierForm": {
    "form": {
      "firstName": {
        "required": true,
        "regex": "^[A-Za-z -]{1,50}$",
        "errMsg": "First Name is a required field and should be 1-50 characters.",
        "formSection": "personal"
      },
      "lastName": {
        "required": true,
        "regex": "^[A-Za-z -]{1,50}$",
        "errMsg": "Last Name is a required field and should be 1-50 characters.",
        "formSection": "personal"
      },
      "serviceStartDate": {
        "required": true,
        "errMsg": "Choose a Service start date.",
        "formSection": "switch_move",
        "availableDates": {
          "type": "object",
          "description": "Following properties are optional it will change based on plan",
          "properties": {
            "move": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "2021-01-01"
              }
            },
            "forward_switch": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "2021-01-01"
              }
            },
            "priority_move": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "2021-01-01"
              }
            }
          }
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.