List Activity Interactions

UNDER DEVELOPMENT

The following endpoint can be used to retrieve an array of activity interactions for a given type of object. An interaction is a recipient or sender of an activity, and can be either a contact or staff object.

GET /activites/:activity_id/interacts

GET /activities/:id/recipients is now deprecated

This endpoint replaced the now deprecated recipients endpoint. Please start using the interacts endpoint. In the near future the recipients endpoint will cease to work.

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response. This argument is used when loading details for both contact and staff interactions.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. Please see both contact and staff for details on handling their object responses.

contacts	array	Array of contact objects that have an interaction against the activity.
staff	array	Array of staff objects that have an interaction against the activity.

Each contact and staff response will also contain the following interact structure,

id	unsigned	Unique ID identifying the given interaction.
date_opened	unix timestamp	The date the interact opened the activity (if opened)
date_actioned	unix timestamp	The date the interact actioned the activity (if actioned)
type	string	'creator', 'from', 'to', 'cc', 'bcc', 'attendee', 'attended', 'did_not_attend'

For example:

Example Response

{
   "response":{
      "contacts":[
         {
            "surname":"Wagner",
            "interact":{
               "type":"to",
               "id":"833985"
            },
            "firstname":"Kurt",
            "email":"kurt.wagner@sample.com",
            "id":"203971",
            "mobile":"1234 1234"
         }
      ],
      "staff":[
         {
            "id":"1110",
            "firstname":"Christine",
            "interact":{
               "type":"from",
               "date_actioned":"1340043702",
               "id":"2"
            },
            "surname":"Higgins"
         },
         {
            "surname":"Cowling",
            "interact":{
               "type":"to",
               "date_actioned":"1351663599",
               "id":"650302"
            },
            "firstname":"Hugh",
            "id":"122"
         },
         {
            "id":"10040",
            "surname":"McQueen",
            "interact":{
               "type":"to",
               "date_actioned":"1340049857",
               "id":"650201"
            },
            "firstname":"Geoff"
         }
      ]
   },
   "meta":{
      "message":"Everything executed as expected.",
      "more_info":"https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok",
      "status":"ok"
   }
}