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

Users

PreviousUser groupsNextAlerts

Get the user

get

Get the user

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //users/{userId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "email": "name@gmail.com",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-06-16",
    "endDate": "2025-06-16",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

Delete the user

delete

Delete the user

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Responses
200
successful operation
application/json
Responseobject
400
Invalid status value
application/json
delete
DELETE //users/{userId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
{}
  • GETList the users
  • POSTCreates a new user assigning them a server generated ID
  • GETGet the user
  • PUTUpdate the user
  • DELETEDelete the user

List the users

get

List the users

Authorizations
Responses
200
successful operation
application/json
400
Invalid status value
application/json
get
GET //users HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "users": {
    "email": "name@gmail.com",
    "firstName": "text",
    "lastName": "text",
    "timezone": "text",
    "userType": "text",
    "access": {
      "startDate": "2025-06-16",
      "endDate": "2025-06-16",
      "preventDownload": "no",
      "restrictProjects": "no"
    }
  }
}

Creates a new user assigning them a server generated ID

post

Creates a new user assigning them a server generated ID

Authorizations
Body

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

emailstring · emailRequired
firstNamestringRequired
lastNamestringRequired
timezonestringOptional
userTypestringOptional
Responses
200
successful operation
application/json
400
Invalid status value
application/json
post
POST //users HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "email": "name@gmail.com",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-06-16",
    "endDate": "2025-06-16",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}
{
  "email": "name@gmail.com",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-06-16",
    "endDate": "2025-06-16",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

Update the user

put

Update the user

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Body

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

emailstring · emailRequired
firstNamestringRequired
lastNamestringRequired
timezonestringOptional
userTypestringOptional
Responses
200
successful operation
application/json
Responseobject
400
Invalid status value
application/json
put
PUT //users/{userId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "email": "name@gmail.com",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-06-16",
    "endDate": "2025-06-16",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}
{}