Includes

When interacting with the Limecraft Flow API to retrieve resources, it’s common to need varying levels of detail or additional properties beyond the basic set returned by default. To cater to this need, we support the use of query parameters, such as the include parameter, to specify which additional properties should be included in the response. This document serves as a guide to understanding and using the 'include' query parameter effectively.

The include parameter allows clients to request additional properties or related resources to be included in the response along with the primary resource. By specifying specific properties or relationships, clients can tailor the response payload to their exact requirements, reducing unnecessary data transfer and processing overhead.

The include parameter can be used multiple times within a single request, with each occurrence representing a distinct property or relationship to include.

For example: