Overview

Related Activities

Summary

This endpoint will return related activity records for a specific record.

Request Arguments

Name Type Description Required
module_list String A list of modules from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be included.
Example: Meetings,Calls,Emails,Notes
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
max_num String 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
deleted Boolean Boolean to show deleted records in the result set. Default is false. 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
add_create_record Integer This option can be used to add Create activities to the response. Default is 0. False

Request

{
}

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":"2f9abe52-f03f-11e9-858c-3c15c2d57622",
         "name":"test call",
         "date_entered":"2019-10-16T11:02:57-07:00",
         "date_modified":"2019-10-16T11:02:57-07:00",
         "description":"",
         "date_start":"2019-10-25T11:30:00-07:00",
         "status":"Planned",
         "contact_name":"",
         "contacts":{
            "name":"",
            "id":"",
            "_acl":{
               "fields":[

               ],
               "_hash":"654d337e0e912edaa00dbb0fb3dc3c17"
            }
         },
         "contact_id":"",
         "locked_fields":[

         ],
         "assigned_user_id":"1",
         "assigned_user_name":"Administrator",
         "assigned_user_link":{
            "full_name":"Administrator",
            "id":"1",
            "_acl":{
               "fields":{
                  "pwd_last_changed":{
                     "write":"no",
                     "create":"no"
                  },
                  "last_login":{
                     "write":"no",
                     "create":"no"
                  }
               },
               "delete":"no",
               "_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
            }
         },
         "_acl":{
            "fields":{

            }
         },
         "_module":"Calls",
         "moduleNameSingular":"Call",
         "moduleName":"Calls"
      },
   ]
}

Change Log

Version Change
v11.7 Added //:record/link/related_activities GET endpoint.
v11.23 Added //:record/related_activities POST endpoint.
//:record/related_activities GET endpoint was marked as deprecated.