API Documentation
  • API Documentation
  • Ecosuite Project Data API
    • Authentication
    • OpenAPI reference
      • Events
        • Resolve
      • Feedback
      • Profile
      • Portfolios
      • Projects
        • Contacts
        • Pro forma
          • Versions
        • I2x
        • Records
        • Sites
          • Records
          • Systems
            • Records
        • Record documents
      • Record documents
      • Records
        • Record documents
      • Service requests
        • Generate
        • Resolve
      • Tariff
      • User groups
      • Users
        • Alerts
        • Groups
          • Reset
        • Mfa
        • Notifications
        • Resend
      • User types
      • Audit
        • Assets
        • Projects
        • Users
      • Coda
        • Milestones
        • Import
      • Connectivity
        • Data
        • Devices
      • Dashboard
        • Status
      • Energy
        • Datums
          • Most recent
          • Projects
          • Consumption
            • Cost
              • Projects
            • Predicted
              • Projects
            • Projects
          • Cumulative
            • Projects
          • Generation
            • Expected
            • Predicted
              • Projects
          • Nodes
            • Projects
        • Export
        • Instantaneous
        • Readings
        • Status
      • Finance
        • Cashflow totals
        • Report
        • Transactions
        • Sources uses
          • Sources uses
        • Export
          • Report
        • Projects
          • Billing
          • CashFlowTimeSeriesArrears
          • Categories
          • Irr categories
          • Report
          • Settings
          • Sources uses
          • Import
          • Cash flows
            • Payment logs
          • Pro forma
            • Irr
        • Record
          • Payments
        • Softledger
          • Locations
      • Media
        • Files
        • Tags
          • Storage
            • Code
            • Labels
          • Default
        • Storage
          • File
          • Code
      • Public
        • Projects
        • Energy
          • Datums
            • Projects
          • Readings
            • Projects
      • Schemas
        • Rfi
        • RfiReply
        • Dr event
        • Dr notification
        • Event
        • Participant
        • Finance
        • Notification
        • Portfolio
        • Pro forma
        • Profile
        • Project
        • Record
        • Service request
        • Site
        • System
        • User
        • User type
        • User groups
        • New tariff
        • Tariff
      • Rfi
        • Thread
          • Code
          • Resolve
          • Version
          • Replies
        • Reply
          • Version
      • Search
        • Refinements
      • Solarnetwork
        • Devices
        • Instruction
        • Nodes
        • Ssh
        • Credentials
          • Solarflux
          • Solarnode
          • Ssh
        • Metadata
          • Projects
        • Settings
          • Node ids
        • Solarnode
          • Login url
      • Tools
        • Address business details
      • Dr
        • Participants
        • Dr events
        • Dr notifications
      • Report
        • Operating
          • Project
      • Weather
        • Datums
          • Projects
        • Daylight
          • Projects
            • Sites
        • Projects
          • Sites
    • OpenAPI Specification
  • Ecosuite Time Series Data API
Powered by GitBook
On this page
  1. Ecosuite Project Data API
  2. OpenAPI reference

Projects

PreviousPortfoliosNextContacts

List the available projects

get

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

Authorizations
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
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
Path parameters
projectIdstringRequired

The project ID

Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
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-06-16",
    "reportStartDate": "2025-06-16",
    "productionStartDate": "2025-06-16",
    "generationStartDate": "2025-06-16",
    "consumptionStartDate": "2025-06-16",
    "storageStartDate": "2025-06-16",
    "timezone": "text",
    "icons": [
      {
        "iconName": "text",
        "meaning": "text",
        "tooltip": "text"
      }
    ],
    "revenueType": "communitySolar",
    "bizDevOwner": "text",
    "siteSurveyor": "text",
    "slackChannel": "text",
    "ganttChartLastUpdated": "2025-06-16",
    "milestones": {
      "initiated": "2025-06-16",
      "interconnection": "2025-06-16",
      "permitting": "2025-06-16",
      "preConstruction": "2025-06-16",
      "construction": "2025-06-16",
      "pto": "2025-06-16",
      "operational": "2025-06-16"
    },
    "assetManagementTeamContact": {
      "name": "DevCo",
      "email": "assetmanagement@ecogyenergy.com",
      "phone": "718-395-3620"
    },
    "reports": {
      "operating": true
    },
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "tags": [
      "text"
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-06-16T11:40:49.176Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-06-16T11:40:49.176Z"
          }
        ]
      }
    ],
    "media": {
      "banner": "text"
    }
  }
}

Deletes an existing project

delete

Deletes an existing project

Authorizations
Path parameters
projectIdstringRequired

The project ID

Responses
200
successful operation
application/json
Responseobject
400
Invalid status value
application/json
delete
DELETE //projects/{projectId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
{}
  • GETList the available projects
  • GETGet project details
  • POSTCreate a new project
  • PUTUpdate an existing project
  • DELETEDeletes an existing project

Create a new project

post

Create a new project with the specified ID

Authorizations
Path parameters
projectIdstringRequired

The project ID

Body

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

codestringRequiredPattern: ^[A-Z0-9]*$
dcSizenumberRead-onlyOptional
statusstring · enumRequiredDefault: New ProjectPossible values:
systemStatusstringRead-onlyOptional

The aggregated system status

pausedbooleanOptionalDefault: false
cancelledbooleanOptionalDefault: false
archivedbooleanOptionalDefault: false
namestringRequired
addressstringRequired
townstringRequired
statestringRequired
latnumber · min: -180 · max: 180Required
longnumber · min: -180 · max: 180Required
discountRatenumberOptional
einNumberstringOptional
companyNamestringOptional
clientNumberstringOptional
startDatestring · dateRequired
reportStartDatestring · dateOptional
productionStartDatestring · dateOptional
generationStartDatestring · dateOptional
consumptionStartDatestring · dateOptional
storageStartDatestring · dateOptional
timezonestringRequired
revenueTypestring · enumOptionalPossible values:
bizDevOwnerstringOptional
siteSurveyorstringOptional
slackChannelstringOptional
ganttChartLastUpdatedstring · dateOptional
tagsstring[]Optional
Responses
200
successful operation
application/json
400
Invalid status value
application/json
post
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-06-16",
  "reportStartDate": "2025-06-16",
  "productionStartDate": "2025-06-16",
  "generationStartDate": "2025-06-16",
  "consumptionStartDate": "2025-06-16",
  "storageStartDate": "2025-06-16",
  "timezone": "text",
  "icons": [
    {
      "iconName": "text",
      "meaning": "text",
      "tooltip": "text"
    }
  ],
  "revenueType": "communitySolar",
  "bizDevOwner": "text",
  "siteSurveyor": "text",
  "slackChannel": "text",
  "ganttChartLastUpdated": "2025-06-16",
  "milestones": {
    "initiated": "2025-06-16",
    "interconnection": "2025-06-16",
    "permitting": "2025-06-16",
    "preConstruction": "2025-06-16",
    "construction": "2025-06-16",
    "pto": "2025-06-16",
    "operational": "2025-06-16"
  },
  "assetManagementTeamContact": {
    "name": "DevCo",
    "email": "assetmanagement@ecogyenergy.com",
    "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-06-16",
    "reportStartDate": "2025-06-16",
    "productionStartDate": "2025-06-16",
    "generationStartDate": "2025-06-16",
    "consumptionStartDate": "2025-06-16",
    "storageStartDate": "2025-06-16",
    "timezone": "text",
    "icons": [
      {
        "iconName": "text",
        "meaning": "text",
        "tooltip": "text"
      }
    ],
    "revenueType": "communitySolar",
    "bizDevOwner": "text",
    "siteSurveyor": "text",
    "slackChannel": "text",
    "ganttChartLastUpdated": "2025-06-16",
    "milestones": {
      "initiated": "2025-06-16",
      "interconnection": "2025-06-16",
      "permitting": "2025-06-16",
      "preConstruction": "2025-06-16",
      "construction": "2025-06-16",
      "pto": "2025-06-16",
      "operational": "2025-06-16"
    },
    "assetManagementTeamContact": {
      "name": "DevCo",
      "email": "assetmanagement@ecogyenergy.com",
      "phone": "718-395-3620"
    },
    "reports": {
      "operating": true
    },
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "tags": [
      "text"
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-06-16T11:40:49.176Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-06-16T11:40:49.176Z"
          }
        ]
      }
    ],
    "media": {
      "banner": "text"
    }
  }
}

Update an existing project

put

Update an existing project

Authorizations
Path parameters
projectIdstringRequired

The project ID

Body

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

codestringRequiredPattern: ^[A-Z0-9]*$
dcSizenumberRead-onlyOptional
statusstring · enumRequiredDefault: New ProjectPossible values:
systemStatusstringRead-onlyOptional

The aggregated system status

pausedbooleanOptionalDefault: false
cancelledbooleanOptionalDefault: false
archivedbooleanOptionalDefault: false
namestringRequired
addressstringRequired
townstringRequired
statestringRequired
latnumber · min: -180 · max: 180Required
longnumber · min: -180 · max: 180Required
discountRatenumberOptional
einNumberstringOptional
companyNamestringOptional
clientNumberstringOptional
startDatestring · dateRequired
reportStartDatestring · dateOptional
productionStartDatestring · dateOptional
generationStartDatestring · dateOptional
consumptionStartDatestring · dateOptional
storageStartDatestring · dateOptional
timezonestringRequired
revenueTypestring · enumOptionalPossible values:
bizDevOwnerstringOptional
siteSurveyorstringOptional
slackChannelstringOptional
ganttChartLastUpdatedstring · dateOptional
tagsstring[]Optional
Responses
200
successful operation
application/json
400
Invalid status value
application/json
put
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-06-16",
  "reportStartDate": "2025-06-16",
  "productionStartDate": "2025-06-16",
  "generationStartDate": "2025-06-16",
  "consumptionStartDate": "2025-06-16",
  "storageStartDate": "2025-06-16",
  "timezone": "text",
  "icons": [
    {
      "iconName": "text",
      "meaning": "text",
      "tooltip": "text"
    }
  ],
  "revenueType": "communitySolar",
  "bizDevOwner": "text",
  "siteSurveyor": "text",
  "slackChannel": "text",
  "ganttChartLastUpdated": "2025-06-16",
  "milestones": {
    "initiated": "2025-06-16",
    "interconnection": "2025-06-16",
    "permitting": "2025-06-16",
    "preConstruction": "2025-06-16",
    "construction": "2025-06-16",
    "pto": "2025-06-16",
    "operational": "2025-06-16"
  },
  "assetManagementTeamContact": {
    "name": "DevCo",
    "email": "assetmanagement@ecogyenergy.com",
    "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-06-16",
    "reportStartDate": "2025-06-16",
    "productionStartDate": "2025-06-16",
    "generationStartDate": "2025-06-16",
    "consumptionStartDate": "2025-06-16",
    "storageStartDate": "2025-06-16",
    "timezone": "text",
    "icons": [
      {
        "iconName": "text",
        "meaning": "text",
        "tooltip": "text"
      }
    ],
    "revenueType": "communitySolar",
    "bizDevOwner": "text",
    "siteSurveyor": "text",
    "slackChannel": "text",
    "ganttChartLastUpdated": "2025-06-16",
    "milestones": {
      "initiated": "2025-06-16",
      "interconnection": "2025-06-16",
      "permitting": "2025-06-16",
      "preConstruction": "2025-06-16",
      "construction": "2025-06-16",
      "pto": "2025-06-16",
      "operational": "2025-06-16"
    },
    "assetManagementTeamContact": {
      "name": "DevCo",
      "email": "assetmanagement@ecogyenergy.com",
      "phone": "718-395-3620"
    },
    "reports": {
      "operating": true
    },
    "links": [
      {
        "name": "text",
        "url": "https://example.com"
      }
    ],
    "tags": [
      "text"
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-06-16T11:40:49.176Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-06-16T11:40:49.176Z"
          }
        ]
      }
    ],
    "media": {
      "banner": "text"
    }
  }
}