Projects

List the available projects

get

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

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Query parameters

projectIdsstringOptional

Optional list of comma separated projectIds to restrict the response to

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/projects

HTTPcURLJavaScriptPython

GET /projects HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "projects": [
    null,
    null
  ]
}

Get project details

get

Gets the details for the specified project

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/projects/{projectId}

HTTPcURLJavaScriptPython

GET /projects/{projectId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

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

Create a new project

post

Create a new project with the specified ID

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

Body

application/json

Refer to the /schemas/project endpoint for the full JSON Schema definition

anyOptional

anyOptional

or

or

and

anyOptional

anyOptional

or

or

Responses

200

successful operation

application/json

400

Invalid status value

application/json

post

/projects/{projectId}

HTTPcURLJavaScriptPython

POST /projects/{projectId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1411

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

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

Update an existing project

put

Update an existing project

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

Body

application/json

Refer to the /schemas/project endpoint for the full JSON Schema definition

anyOptional

anyOptional

or

or

and

anyOptional

anyOptional

or

or

Responses

200

successful operation

application/json

400

Invalid status value

application/json

put

/projects/{projectId}

HTTPcURLJavaScriptPython

PUT /projects/{projectId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1411

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

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

Deletes an existing project

delete

Deletes an existing project

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

delete

/projects/{projectId}

HTTPcURLJavaScriptPython

DELETE /projects/{projectId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}