Records | API Documentation

List the records

get

List the records

Authorizations

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

GET //records HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

[
  null,
  null
]

Find the record by record ID

get

Use a record ID to fetch record information

Path parameters

recordIdstringRequired

The record ID

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

GET //records/{recordId} HTTP/1.1
Host: api.ecosuite.io
Accept: */*

{
  "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:39:10.222Z",
      "resolved": true,
      "comments": [
        {
          "comment": "text",
          "userName": "text",
          "created": "2025-09-16T12:39:10.222Z"
        }
      ]
    }
  ],
  "verified": false,
  "hiddenFields": [
    "text"
  ]
}

Delete a record

delete

Delete a record

Authorizations

Path parameters

recordIdstringRequired

The record ID

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

delete

DELETE //records/{recordId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}