List related records

List what is linked to a record: activities, history, documents or contacts.

GET https://cotlet.dev/api/v1/suitecrm/records/{record_id}/relateds

read

Reads the same tiles as the Relationships section of the record. Contacts exist on Opportunities and Cases, Documents on Leads, Opportunities and Cases, Activities and History on Leads, Opportunities and Cases. A tile the module does not have returns an error naming the valid ones.

Parameters

Parameters: list_related
NameTypeDescription
module string required string Module: Leads, Contacts, Accounts, Opportunities, Cases, Tasks, Calls, Meetings or Notes.
record_id string required string Record ID from list_records.
subpanel string required string One of: activities (open Calls, Meetings, Tasks, Emails), history (archived emails and completed activities), documents, contacts.
cursor string string Next page cursor from the previous call.

Request

cURL
curl "https://cotlet.dev/api/v1/suitecrm/records/record_8c41d2/relateds?module=module&subpanel=subpanel" \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("suitecrm", "list_related", {"module":"module","record_id":"record_8c41d2","subpanel":"subpanel"})
Node.js
const result = await cotlet.call('suitecrm', 'list_related', {"module":"module","record_id":"record_8c41d2","subpanel":"subpanel"});
CLI
cotlet call suitecrm list_related --data '{"module":"module","record_id":"record_8c41d2","subpanel":"subpanel"}'

Example response

JSON

{
  "record_id": "8f2a41c7-6d3e-90b5-17ac-4e5d0b9a2c61",
  "subpanel": "history",
  "items": [
    {
      "type": "Call",
      "subject": "Intro call with Tom Becker",
      "status": "Held",
      "date": "2026-10-08"
    },
    {
      "type": "Email",
      "subject": "Quote v1",
      "status": "Archived",
      "date": "2026-10-12"
    }
  ],
  "next_cursor": null
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.