Records

List the records for a system

get

List the records for the specified system

Authorizations
Path parameters
projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Responses
200

successful operation

application/json
get
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
Path parameters
projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

Body

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

namestringRequired
isContractstring · enumRequiredPossible values:
recordTypestring · enumRequiredPossible values:
verifiedbooleanOptionalDefault: false
hiddenFieldsstring[]Optional
Responses
200

successful operation

application/json
post
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-09-16T12:45:53.890Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-09-16T12:45:53.890Z"
          }
        ]
      }
    ],
    "verified": false,
    "hiddenFields": [
      "text"
    ]
  }
}

Update an existing system record

put

Update an existing system record

Authorizations
Path parameters
projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

systemIdstringRequired

The system ID

recordIdstringRequired

The record ID

Body

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

namestringRequired
isContractstring · enumRequiredPossible values:
recordTypestring · enumRequiredPossible values:
verifiedbooleanOptionalDefault: false
hiddenFieldsstring[]Optional
Responses
200

successful operation

application/json
put
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-09-16T12:45:53.890Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-09-16T12:45:53.890Z"
          }
        ]
      }
    ],
    "verified": false,
    "hiddenFields": [
      "text"
    ]
  }
}
PreviousSystemsNextRecord documents