Activities Documentation

A summary of best practices on accessing Activities API. All items described here can be used simultaneously.

Sideloading

All relevant Activity relationships can be accessed in a single request by adding the include parameter

/api/actuals/activities?include=activity_fields,operations,product_applications,seedings

Sideloading works for nested objects as well with a .:

/api/actuals/activities?include=product_applications.product

Refer to specification for more details

We recommend to always use filters when reading information from this API. The following attributes can be used to narrow down the result list

Single grower

/api/actuals/activities?filter[grower_id]=1

Multiple growers

/api/actuals/activities?filter[grower_id]=1,2

Date attributes of activity can be filtered using comparisions (one of gt, lt or eq). The format of the filter will be:

/api/actuals/activities?filter[attribute name][comparison operator]=Date in YYYY-MM-DD format (or any ISO8601)

Activities created after date

/api/actuals/activities?filter[created_at][gt]=2024-01-01

Activities updated before date

/api/actuals/activities?filter[updated_at][lt]=2024-01-01

Activities created between dates

/api/actuals/activities?filter[created_at][gt]=2024-01-01&filter[created_at][lt]=2025-01-01