Sign in
favorites

Group By favorites

Groups favorites by specified fields and optionally computes aggregate values for each group.

get/favorites/groupBy

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/favorites/groupBy
  • Auth: HTTP bearer

Query parameters

group_bystring required

Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.

filterstring

Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.

order_bystring

Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.

limitinteger

Limits the number of objects returned.

view_idstring uuid

View ID to apply filters from.

aggregatestring

Array of aggregate operations to compute for each group.

include_records_sampleboolean

If true, includes a sample of records for each group in the response.

order_by_for_recordsstring

Order by clause for records within each group. Only applicable when include_records_sample is true.

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.