The Dash API introduces two custom request parameters that are used across all endpoints but are not part of the standard JSON:API specification: filter and filterRelations.
In addition, the Dash API supports default and optional request extensions, formatted as dash-{optional}, which are available on certain endpoints. These flags allow users to run complex business processes via API requests.
- Default flags are enabled automatically but can be disabled by passing the value false.
- Optional flags may accept string values for customization.
Parameter Overview
- filter: A nested object that represents the WHERE clause of an SQL statement.
- filterRelations: A boolean parameter that specifies whether filters targeting included relationships should also be applied to those relationships, rather than only to the primary query target.
Example
- Filter Customers Request:
/api/v1/customers?filter[signatures.waiver.is_active]=true&include=signatures.waiver&filterRelations=true - Explanation:
filter[signatures.waiver.is_active]=true→ returns customers who have a signature on a valid waiver.include=signatures.waiver→ includes customer signatures and the related waiver in the response.
Without filterRelations=true, the rows returned will include all signatures and waivers for customers who have signed at least one active waiver.
With filterRelations=true, only signatures on active waivers are returned.