Get Campaigns

Get Campaigns Endpoint

To successfully obtain available Campaigns information for an account, the following endpoint can be used:

Endpoint:
https://api.novasole.com/campaigns

Request Method:
GET

Request Body

This endpoint just requires a valid bearer token. No additional request body is needed. To obtain a valid bearer token, please refer to the Authentication page for more information.

Successful Response

A successful request provides a list of all available Campaign information for your account.

[
  {
    "id": 1,
    "name": "name_of_campaign"
  }
]

Using the Campaign Id’s

The campaign Id’s can be used in the request body for the Create Scan. A campaign contains certain preferences on defaults for creating an energy system. This information will be automatically retrieved in the Create Scan endpoint when passing a certain Campaign Id in the request body of that endpoint.