Projects

PreviousPortfolios NextContacts

List the available projects

List the available projects, restricted to those the user making the call can access

get

/projects

Authorizations

Query parameters

projectIdsstring

Optional list of comma separated projectIds to restrict the response to

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.ecosuite.io//projects' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{
  "projects": [
    null,
    null
  ]
}

successful operation

Get project details

Gets the details for the specified project

get

/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.ecosuite.io//projects/{projectId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{
  "project": {
    "code": "text",
    "dcSize": 1,
    "systemStatus": "text",
    "paused": false,
    "cancelled": false,
    "archived": false,
    "name": "text",
    "address": "text",
    "town": "text",
    "state": "text",
    "lat": 1,
    "long": 1,
    "discountRate": 1,
    "einNumber": "text",
    "companyName": "text",
    "clientNumber": "text",
    "startDate": "2025-02-23",
    "reportStartDate": "2025-02-23",
    "productionStartDate": "2025-02-23",
    "generationStartDate": "2025-02-23",
    "consumptionStartDate": "2025-02-23",
    "storageStartDate": "2025-02-23",
    "timezone": "text",
    "bizDevOwner": "text",
    "siteSurveyor": "text",
    "slackChannel": "text",
    "ganttChartLastUpdated": "2025-02-23",
    "status": "New Project",
    "revenueType": "communitySolar",
    "tags": [
      "text"
    ],
    "milestones": {
      "initiated": "2025-02-23",
      "interconnection": "2025-02-23",
      "permitting": "2025-02-23",
      "preConstruction": "2025-02-23",
      "construction": "2025-02-23",
      "pto": "2025-02-23",
      "operational": "2025-02-23"
    },
    "assetManagementTeamContact": {
      "name": "DevCo",
      "email": "assetmanagement@ecogyenergy.com",
      "phone": "718-395-3620"
    },
    "media": {
      "banner": "text"
    },
    "interconnection": {
      "fipsLocation": "text",
      "estimatedCostOfStudiesAndFees": 0,
      "estimatedCostOfSystemUpgrades": 0,
      "finalCostOfInterconnection": 0,
      "ieee1547ReactivePowerCategory": "A",
      "ieee1547DisturbanceCategory": "I",
      "withdrawalReason": "notApplicable"
    },
    "icons": [
      {
        "iconName": "text",
        "meaning": "text",
        "tooltip": "text"
      }
    ],
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-02-23T22:28:23.904Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-02-23T22:28:23.904Z"
          }
        ]
      }
    ],
    "reports": {
      "operating": true
    }
  }
}

successful operation

Create a new project

Create a new project with the specified ID

post

/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//projects/{projectId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","paused":false,"cancelled":false,"archived":false,"name":"text","address":"text","town":"text","state":"text","lat":1,"long":1,"startDate":"2025-02-23","timezone":"text","status":"New Project","revenueType":"communitySolar","tags":[null],"milestones":{"initiated":"2025-02-23","interconnection":"2025-02-23","permitting":"2025-02-23","preConstruction":"2025-02-23","construction":"2025-02-23","pto":"2025-02-23","operational":"2025-02-23"},"assetManagementTeamContact":{"name":"DevCo","email":"assetmanagement@ecogyenergy.com","phone":"718-395-3620"},"media":{"banner":"text"},"interconnection":{"fipsLocation":"text","estimatedCostOfStudiesAndFees":0,"estimatedCostOfSystemUpgrades":0,"finalCostOfInterconnection":0,"ieee1547ReactivePowerCategory":"A","ieee1547DisturbanceCategory":"I","withdrawalReason":"notApplicable"},"icons":[{"iconName":"text","meaning":"text","tooltip":"text"}],"links":[{"name":"text","url":"https://example.com"}],"notes":[{"note":"text","userName":"text","created":"2025-02-23T22:28:23.904Z","resolved":true,"comments":[{"comment":"text","userName":"text","created":"2025-02-23T22:28:23.904Z"}]}],"reports":{"operating":true}}'

200

400

{
  "project": {
    "code": "text",
    "dcSize": 1,
    "systemStatus": "text",
    "paused": false,
    "cancelled": false,
    "archived": false,
    "name": "text",
    "address": "text",
    "town": "text",
    "state": "text",
    "lat": 1,
    "long": 1,
    "discountRate": 1,
    "einNumber": "text",
    "companyName": "text",
    "clientNumber": "text",
    "startDate": "2025-02-23",
    "reportStartDate": "2025-02-23",
    "productionStartDate": "2025-02-23",
    "generationStartDate": "2025-02-23",
    "consumptionStartDate": "2025-02-23",
    "storageStartDate": "2025-02-23",
    "timezone": "text",
    "bizDevOwner": "text",
    "siteSurveyor": "text",
    "slackChannel": "text",
    "ganttChartLastUpdated": "2025-02-23",
    "status": "New Project",
    "revenueType": "communitySolar",
    "tags": [
      "text"
    ],
    "milestones": {
      "initiated": "2025-02-23",
      "interconnection": "2025-02-23",
      "permitting": "2025-02-23",
      "preConstruction": "2025-02-23",
      "construction": "2025-02-23",
      "pto": "2025-02-23",
      "operational": "2025-02-23"
    },
    "assetManagementTeamContact": {
      "name": "DevCo",
      "email": "assetmanagement@ecogyenergy.com",
      "phone": "718-395-3620"
    },
    "media": {
      "banner": "text"
    },
    "interconnection": {
      "fipsLocation": "text",
      "estimatedCostOfStudiesAndFees": 0,
      "estimatedCostOfSystemUpgrades": 0,
      "finalCostOfInterconnection": 0,
      "ieee1547ReactivePowerCategory": "A",
      "ieee1547DisturbanceCategory": "I",
      "withdrawalReason": "notApplicable"
    },
    "icons": [
      {
        "iconName": "text",
        "meaning": "text",
        "tooltip": "text"
      }
    ],
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-02-23T22:28:23.904Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-02-23T22:28:23.904Z"
          }
        ]
      }
    ],
    "reports": {
      "operating": true
    }
  }
}

successful operation

Update an existing project

put

/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//projects/{projectId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"code":"text","paused":false,"cancelled":false,"archived":false,"name":"text","address":"text","town":"text","state":"text","lat":1,"long":1,"startDate":"2025-02-23","timezone":"text","status":"New Project","revenueType":"communitySolar","tags":[null],"milestones":{"initiated":"2025-02-23","interconnection":"2025-02-23","permitting":"2025-02-23","preConstruction":"2025-02-23","construction":"2025-02-23","pto":"2025-02-23","operational":"2025-02-23"},"assetManagementTeamContact":{"name":"DevCo","email":"assetmanagement@ecogyenergy.com","phone":"718-395-3620"},"media":{"banner":"text"},"interconnection":{"fipsLocation":"text","estimatedCostOfStudiesAndFees":0,"estimatedCostOfSystemUpgrades":0,"finalCostOfInterconnection":0,"ieee1547ReactivePowerCategory":"A","ieee1547DisturbanceCategory":"I","withdrawalReason":"notApplicable"},"icons":[{"iconName":"text","meaning":"text","tooltip":"text"}],"links":[{"name":"text","url":"https://example.com"}],"notes":[{"note":"text","userName":"text","created":"2025-02-23T22:28:23.904Z","resolved":true,"comments":[{"comment":"text","userName":"text","created":"2025-02-23T22:28:23.904Z"}]}],"reports":{"operating":true}}'

200

400

{
  "project": {
    "code": "text",
    "dcSize": 1,
    "systemStatus": "text",
    "paused": false,
    "cancelled": false,
    "archived": false,
    "name": "text",
    "address": "text",
    "town": "text",
    "state": "text",
    "lat": 1,
    "long": 1,
    "discountRate": 1,
    "einNumber": "text",
    "companyName": "text",
    "clientNumber": "text",
    "startDate": "2025-02-23",
    "reportStartDate": "2025-02-23",
    "productionStartDate": "2025-02-23",
    "generationStartDate": "2025-02-23",
    "consumptionStartDate": "2025-02-23",
    "storageStartDate": "2025-02-23",
    "timezone": "text",
    "bizDevOwner": "text",
    "siteSurveyor": "text",
    "slackChannel": "text",
    "ganttChartLastUpdated": "2025-02-23",
    "status": "New Project",
    "revenueType": "communitySolar",
    "tags": [
      "text"
    ],
    "milestones": {
      "initiated": "2025-02-23",
      "interconnection": "2025-02-23",
      "permitting": "2025-02-23",
      "preConstruction": "2025-02-23",
      "construction": "2025-02-23",
      "pto": "2025-02-23",
      "operational": "2025-02-23"
    },
    "assetManagementTeamContact": {
      "name": "DevCo",
      "email": "assetmanagement@ecogyenergy.com",
      "phone": "718-395-3620"
    },
    "media": {
      "banner": "text"
    },
    "interconnection": {
      "fipsLocation": "text",
      "estimatedCostOfStudiesAndFees": 0,
      "estimatedCostOfSystemUpgrades": 0,
      "finalCostOfInterconnection": 0,
      "ieee1547ReactivePowerCategory": "A",
      "ieee1547DisturbanceCategory": "I",
      "withdrawalReason": "notApplicable"
    },
    "icons": [
      {
        "iconName": "text",
        "meaning": "text",
        "tooltip": "text"
      }
    ],
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-02-23T22:28:23.904Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-02-23T22:28:23.904Z"
          }
        ]
      }
    ],
    "reports": {
      "operating": true
    }
  }
}

successful operation

Deletes an existing project

delete

/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.ecosuite.io//projects/{projectId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

successful operation