...
| _page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. | |
|---|---|---|---|
| _limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. | |
| _offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page. | |
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. | |
| _filters | partial_string |
Filtering Activities
You can filter the returned list using the _filters parameter.
| Name | Example | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| owner_type | ||||||||
| type | ||||||||
| invitation | ||||||||
| read | read(no) or read(0) or read(n) | |||||||
| parent_id | ||||||||
| thread_id | ||||||||
| staff_id | ||||||||
| priority_id | ||||||||
| class_id | ||||||||
| task_id | ||||||||
| message_id | ||||||||
| owner_id | ||||||||
| visibility | ||||||||
| medium | ||||||||
| against_type | against_type(company,job) | Only return activities against the given type | ||||||
| against_id | against_id(12,12) | Only return activities against object with given ids. | ||||||
| order_by_asc | order_by_asc(date_ended) | date_started, date_created, date_ended, date_logged, date_modified and id
| ||||||
| order_by_desc | Same as order_by_asc but opposite direction | |||||||
| date_created_before | ||||||||
| date_created_after | ||||||||
| date_started_before | ||||||||
| date_started_after | ||||||||
| date_logged_before | ||||||||
| date_logged_after | ||||||||
| date_ended_before | ||||||||
| date_ended_after | ||||||||
| date_modified_after | ||||||||
| date_modified_before | ||||||||
| max_id | ||||||||
| min_id | ||||||||
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>)
| _filters=id_greater_than(5) | Available fields: id |
| Info |
|---|
Using the |
...
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 | ||
| message_id | string | The custom message id | |
| date_created | unix ts | ||
| date_started | unix ts | ||
| date_ended | unix ts | ||
| date_due | unix ts | ||
| date_updated | unix ts | ||
| staff | unsigned or object | ||
| priority | unsigned or object | ||
| rate | unsigned or object | ||
| rate_charged | unsigned float | The rate charged for the activity. If the rate has been changed for a particular activity, this will show the changed rate. | |
| class | unsigned or object | Activity's class. | |
| task | unsigned or object | The task the activity is against if any. | |
| interacts | N/A | Adds an "interacts" array to each activity response. Please see Handling Interacts below for more information. |
...
Fields that can be object indicate the field can be requested as a resource. For example.
...