//:record/link/history GET
Overview
Lists history records.
Summary
This endpoint will return a set of history modules (meetings, calls, notes, tasks, emails) records.
Request Arguments
Name | Type | Description | Required |
---|---|---|---|
max_num | Integer | A maximum number of records to return. Default is 20. | False |
offset | Integer | The number of records to skip over before records are returned. Default is 0. | False |
order_by | String | How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon. Example: name:DESC,account_type:DESC,date_modified:ASC |
False |
deleted | Boolean | Boolean to show deleted records in the result set. | False |
module_list | String | A list of modules from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be included | False |
alias_fields | Array | A list of field aliases from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be fetched. These field aliases can also be used in 'order_by'. Example:
{
'record_date':
{
'Calls': 'date_start',
'Emails': 'date_sent'
}
}
|
False |
Filter
There are four types of filters:
Basic
This will filter the results by modules Calls and Meetings.
Query String Example:
module_list=Calls,Meetings
Response Arguments
Name | Type | Description |
---|---|---|
next_offset | Integer | Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records. |
records | Array | An array of results containing matched records. |
Response
{
"next_offset": -1,
"records": [
{
"id": "dd4633c2-370d-11f0-b034-0242ac120003",
"name": "Review needs",
"date_entered": "2025-05-22T09:08:33-04:00",
"date_modified": "2025-05-22T09:08:33-04:00",
"description": "Meeting to discuss project plan and hash out the details of implementation",
"status": "Held",
"contact_name": "",
"contacts": {
"name": "",
"id": "",
"_acl": {
"fields": {
"sf_lastactivity_default": {
"create": "no",
"write": "no",
"license": "no"
},
"dri_workflow_template_id": {
"create": "no",
"write": "no",
"license": "no"
},
"dri_workflow_template_name": {
"create": "no",
"write": "no",
"license": "no"
}
},
"_hash": "f5b93010f8cce13da10052660deff5f4"
}
},
"contact_id": "",
"locked_fields": [],
"assigned_user_id": "seed_sarah_id",
"assigned_user_name": "Sarah Smith",
"assigned_user_link": {
"full_name": "Sarah Smith",
"id": "seed_sarah_id",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"_acl": {
"fields": {}
},
"_module": "Meetings",
"moduleNameSingular": "Meeting",
"moduleName": "Meetings",
"date_linked": "",
"link_name": "meetings"
},
{
"id": "dd486444-370d-11f0-9a01-0242ac120003",
"date_entered": "2025-05-22T09:08:33-04:00",
"date_modified": "2025-05-22T09:08:33-04:00",
"assigned_user_id": "seed_sarah_id",
"assigned_user_name": "Sarah Smith",
"assigned_user_link": {
"full_name": "Sarah Smith",
"id": "seed_sarah_id",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"description": "Important Meeting to discuss project plan and hash out the details of implementation",
"name": "Demo",
"status": "sent",
"_acl": {
"fields": {}
},
"_module": "Emails",
"moduleNameSingular": "Email",
"moduleName": "Emails",
"date_linked": "",
"link_name": "emails",
"from_addr": "Dwana Mcniel <support.section.im@example.cn>",
"to_addrs": "Sarah Smith <sarah@example.com>"
},
{
"id": "bc7dcd62-370d-11f0-b111-0242ac120003",
"name": "Attended CRM Exceleration Event in Asia",
"date_entered": "2025-05-22T09:07:38-04:00",
"date_modified": "2025-05-22T09:07:38-04:00",
"description": "Contact's event registration fee was comped.",
"contact_id": "",
"contact_name": "",
"contact": {
"name": "",
"id": "",
"_acl": {
"fields": {
"sf_lastactivity_default": {
"create": "no",
"write": "no",
"license": "no"
},
"dri_workflow_template_id": {
"create": "no",
"write": "no",
"license": "no"
},
"dri_workflow_template_name": {
"create": "no",
"write": "no",
"license": "no"
}
},
"_hash": "f5b93010f8cce13da10052660deff5f4"
}
},
"locked_fields": [],
"assigned_user_id": "seed_sarah_id",
"assigned_user_name": "Sarah Smith",
"assigned_user_link": {
"full_name": "Sarah Smith",
"id": "seed_sarah_id",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"_acl": {
"fields": {}
},
"_module": "Notes",
"moduleNameSingular": "Note",
"moduleName": "Notes",
"date_linked": "",
"link_name": "notes"
}
]
}
Change Log
Version | Change |
---|---|
v10 | Added /<module>/:record/link/history GET endpoint. |