v1

latestOpenAPI 3.0.32026-08-06224144516.1 KB
Activities

Filter activities

This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call. For a more in-depth explanation of boolean filtering, consult the section near the top of this page dealing with filtering.

The following are all the Activity fields that can currently be filtered on, and which filters can be used on each:

`id` - greater_than, less_than, between, exactly, is_empty
`data_item.id` - greater_than, less_than, between, exactly, is_empty
`data_item.type` - exactly, is_empty
`date - greater_than`, less_than, between, is_empty
`regarding_id` - greater_than, less_than, between, exactly, is_empty
`type` - exactly, is_empty
`notes` - contains, exactly, is_empty
`entered_by_id` - greater_than, less_than, between, exactly, is_empty
`date_created` - greater_than, less_than, between, is_empty
`date_modified` - greater_than, less_than, between, is_empty
post/activities/search

Query parameters

querystring required

The optional string to search within activities for.

pagenumber required

The current page number of activities to return.

per_pagenumber required

The number of activities to return per page.

Request body

fieldstring required

The field to filter on. See the above list to determine which fields can be filtered.

filterstring required

The filter to use. See the above list to determine which fields allow what filters.

valuestring required

The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts.

Response

OK

countnumber
totalnumber
_linksobject