List records
List records of one module, filtered by text, status, owner or change date.
GET https://cotlet.dev/api/v1/suitecrm/records
read
Returns one page of records with record_id, the module's key fields and next_cursor. Records you cannot see under your role and Security Groups are not returned. Follow next_cursor until it is empty to read a whole queue.
Parameters
| Name | Type | Description |
|---|---|---|
| module string required | string | Module: Leads, Contacts, Accounts, Opportunities, Cases, Tasks, Calls, Meetings or Notes. |
| query string | string | Text to match in the name or subject of the record. |
| status string | string | Status or Sales Stage as shown in the module, for example New for Leads or Closed Won for Opportunities. |
| assigned_to_me boolean | boolean | Only records assigned to you, the My Items filter. |
| modified_since string | string | ISO date; only records changed on or after it. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl "https://cotlet.dev/api/v1/suitecrm/records?module=module" \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("suitecrm", "list_records", {"module":"module"})const result = await cotlet.call('suitecrm', 'list_records', {"module":"module"});cotlet call suitecrm list_records --data '{"module":"module"}'Example response
{
"module": "Leads",
"records": [
{
"record_id": "5c1e7d0a-3b42-8f19-a6d4-2e7b90c1f3a8",
"name": "Ana Lopez",
"status": "New",
"account_name": "Northwind Dental",
"lead_source": "Website",
"assigned_to": "Maya Chen"
},
{
"record_id": "e91d3a77-0c5b-4d28-b6f1-7a2c8e4d9013",
"name": "Sam Okafor",
"status": "New",
"account_name": "Birch Studio",
"lead_source": "Trade Show",
"assigned_to": "Maya Chen"
}
],
"next_cursor": null
}