Records

List the records for a system

get

List the records for the specified system

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/projects/{projectId}/sites/{siteId}/systems/{systemId}/records

HTTPcURLJavaScriptPython

GET /projects/{projectId}/sites/{siteId}/systems/{systemId}/records HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "records": [
    null,
    null
  ]
}

Create a new system record with a server generated ID

post

Create a new system record with a server generated ID

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Body

application/json

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

anyOptional

anyOptional

or

or

and

anyOptional

anyOptional

or

anyOptional

anyOptional

or

or

or

anyOptional

anyOptional

or

or

or

or

anyOptional

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

anyOptional

anyOptional

or

or

or

or

or

or

anyOptional

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200

successful operation

application/json

400

Invalid status value

application/json

post

/projects/{projectId}/sites/{siteId}/systems/{systemId}/records

HTTPcURLJavaScriptPython

POST /projects/{projectId}/sites/{siteId}/systems/{systemId}/records HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "name": "text",
  "isContract": "yes",
  "recordType": "financial",
  "contacts": [
    {
      "name": "text",
      "type": "text",
      "email": "[email protected]",
      "phone": "text",
      "voip": "text",
      "notes": "text"
    }
  ],
  "notes": [
    {
      "note": "text",
      "resolved": true,
      "comments": [
        {
          "comment": "text"
        }
      ]
    }
  ],
  "verified": false,
  "hiddenFields": [
    "text"
  ]
}

{
  "record": {
    "name": "text",
    "isContract": "yes",
    "recordType": "financial",
    "contacts": [
      {
        "name": "text",
        "type": "text",
        "email": "[email protected]",
        "phone": "text",
        "voip": "text",
        "notes": "text"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-12-16T10:46:30.173Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-12-16T10:46:30.173Z"
          }
        ]
      }
    ],
    "verified": false,
    "hiddenFields": [
      "text"
    ]
  }
}

Update an existing system record

put

Update an existing system record

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

recordIdstringRequired

The record ID

Body

application/json

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

anyOptional

anyOptional

or

or

and

anyOptional

anyOptional

or

anyOptional

anyOptional

or

or

or

anyOptional

anyOptional

or

or

or

or

anyOptional

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

anyOptional

anyOptional

or

or

or

or

or

or

anyOptional

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200

successful operation

application/json

400

Invalid status value

application/json

put

/projects/{projectId}/sites/{siteId}/systems/{systemId}/records/{recordId}

HTTPcURLJavaScriptPython

PUT /projects/{projectId}/sites/{siteId}/systems/{systemId}/records/{recordId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "name": "text",
  "isContract": "yes",
  "recordType": "financial",
  "contacts": [
    {
      "name": "text",
      "type": "text",
      "email": "[email protected]",
      "phone": "text",
      "voip": "text",
      "notes": "text"
    }
  ],
  "notes": [
    {
      "note": "text",
      "resolved": true,
      "comments": [
        {
          "comment": "text"
        }
      ]
    }
  ],
  "verified": false,
  "hiddenFields": [
    "text"
  ]
}

{
  "record": {
    "name": "text",
    "isContract": "yes",
    "recordType": "financial",
    "contacts": [
      {
        "name": "text",
        "type": "text",
        "email": "[email protected]",
        "phone": "text",
        "voip": "text",
        "notes": "text"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-12-16T10:46:30.173Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-12-16T10:46:30.173Z"
          }
        ]
      }
    ],
    "verified": false,
    "hiddenFields": [
      "text"
    ]
  }
}