Get Activity

Resource URL

GET /activities/:id

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

id	unsigned	Activity's unique identifier. This can be used to request other endpoints.
subject	string
parent	string	Parent activity endpoints. For example, /activities/13
parent_id	unsigned	Parent activity identifier. For example, 13.
thread	string	Thread activity endpoint. For example, /activities/13.
thread_id	unsigned	Thread activity identifier. For example, 13
against	string	The object endpoint the activity is against. For example, /company/14
against_type	string	The object the activity is against. For example, company or staff.
against_id	unsigned	Unique identifier for the object the activity is against.
owner	string	An endpoint representing the owner. For example, /staff/15 or /affiliation/14
owner_type	string	The type of owner. For example, staff or affiliation.
owner_id	unsigned	The owner's id. For example, 15 or 14.
medium	string	meeting, note, email, etc
body	string	The main content of the activity.
visibility	string	private, all, confidential
details	string	For meetings this is the location, for postals this is the address and for calls this is the number.
message_id	string	The custom message id
date_created	unix ts
date_started	unix ts
date_ended	unix ts
date_due	unix ts
date_modified	unix ts
staff	unsigned or object
priority	unsigned or object
class	unsigned or object	Activity's class.
task	unsigned or object	The task the activity is against if any.
billable	unsigned	Billable time in seconds
nonbillable	unsigned	Non-billable time in seconds
tag	Array of objects	Tags of the activity

Fields that can be object indicate the field can be requested as a resource. For example.

GET /activities.json?_fields=staff

would return the activity's staff id. Where as,

GET /activities.json?_fields=staff(email)

would return the staff object, including any optional fields or objects within the parenthesis. In the above examples case, it would return the staff objects default values and optional email value.

Sample Response

GET /activities/11.json?_fields=staff(email)

{
   "response" : {
         "subject" : "Give a heads up for the fax that I was about to se",
         "staff" : {
            "email" : "geoff.mcqueen@affinitylive.com",
            "firstname" : "Geoff",
            "id" : "1000",
            "surname" : "McQueen"
         },
         "id" : "11"
   },
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}