Records

List the records for a site

get

List the records for the specified site

Authorizations

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site ID

Responses

get

HTTPcURLJavaScriptPython

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

{
  "records": [
    null,
    null
  ]
}

Create a new site record with a server generated ID

post

Create a new site record with a server generated ID

Authorizations

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site 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}/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:23:25.445Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-04-30T07:23:25.445Z"
          }
        ]
      }
    ],
    "verified": true,
    "hiddenFields": [
      "text"
    ]
  }
}

Update an existing site record

put

Update an existing site record

Authorizations

Path parameters

projectIdstringRequired

The project ID

siteIdstringRequired

The site 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}/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:23:25.445Z",
        "resolved": true,
        "comments": [
          {
            "comment": "text",
            "userName": "text",
            "created": "2025-04-30T07:23:25.445Z"
          }
        ]
      }
    ],
    "verified": true,
    "hiddenFields": [
      "text"
    ]
  }
}