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

Records

PreviousRecord documentsNextRecord documents

List the records

get

List the records

Authorizations
Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //records HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
[
  null,
  null
]

Find the record by record ID

get

Use a record ID to fetch record information

Path parameters
recordIdstringRequired

The record ID

Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //records/{recordId} HTTP/1.1
Host: api.ecosuite.io
Accept: */*
{
  "name": "text",
  "isContract": "yes",
  "recordType": "financial",
  "contacts": [
    {
      "name": "text",
      "type": "text",
      "email": "name@gmail.com",
      "phone": "text",
      "voip": "text",
      "notes": "text"
    }
  ],
  "notes": [
    {
      "note": "text",
      "userName": "text",
      "created": "2025-06-16T11:40:49.389Z",
      "resolved": true,
      "comments": [
        {
          "comment": "text",
          "userName": "text",
          "created": "2025-06-16T11:40:49.389Z"
        }
      ]
    }
  ],
  "verified": false,
  "hiddenFields": [
    "text"
  ]
}

Delete a record

delete

Delete a record

Authorizations
Path parameters
recordIdstringRequired

The record ID

Responses
200
successful operation
application/json
Responseobject
400
Invalid status value
application/json
delete
DELETE //records/{recordId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
{}
  • GETList the records
  • GETFind the record by record ID
  • DELETEDelete a record