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

get

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

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

post

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: 285

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

{
  "record": {
    "name": "text",
    "isContract": "yes",
    "recordType": "financial",
    "contacts": [
      {
        "name": "text",
        "type": "text",
        "email": "[e-mail]",
        "phone": "text",
        "voip": "text",
        "notes": "text"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-04-30T07:25:09.339Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-04-30T07:25:09.339Z"
          }
        ]
      }
    ],
    "verified": true,
    "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

put

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: 285

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

{
  "record": {
    "name": "text",
    "isContract": "yes",
    "recordType": "financial",
    "contacts": [
      {
        "name": "text",
        "type": "text",
        "email": "[e-mail]",
        "phone": "text",
        "voip": "text",
        "notes": "text"
      }
    ],
    "notes": [
      {
        "note": "text",
        "userName": "text",
        "created": "2025-04-30T07:25:09.339Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-04-30T07:25:09.339Z"
          }
        ]
      }
    ],
    "verified": true,
    "hiddenFields": [
      "text"
    ]
  }
}