Returns all addresses

Filters by IDs. Multiple inputs with id[]=1&id[]=2

Number of items per Page

Result Page

Order column

Order direction. asc or desc possible

Returns a single aggregate over the filtered list instead of the paginated result, e.g. {"data": {"count": 42}}. Allowed values: count, sum.column, min.column, max.column, avg.column (e.g. return=sum.duration_seconds). sum and avg require a numeric column.

Returns one aggregate row per bucket of the given column instead of the paginated result, e.g. group_by=type_id gives {"data": [{"type_id": 1, "count": 5}, ...]}. The per-bucket aggregate reuses the "return=" grammar and defaults to count (e.g. group_by=type_id&return=sum.id). Combine with order_by=<aggregate>&order_direction=desc for "top N" queries. Groupable columns are known model columns plus foreign keys. Datetime columns must be bucketed by granularity: group_by=created_at:month (also :year, :day/:date), giving {"data": [{"created_at": "2026-07", "count": 5}, ...]}. Results are capped at 1000 buckets.

You can load relations using the with parameter. Example for assignments/appointments: with[]=documents loads all related documents and adds it to the response.

Exclude ids. Multiple inputs with exclude[]=3&exclude[]=6

Filter by customer_id. Multiple inputs with customer_id[]=1&customer_id[]=2

Filter by type. Multiple inputs with type[]=MAILING&type[]=WORK

Filter by use. Multiple inputs with use[]=ADDRESS&use[]=CONTACT

Filter by name. Multiple inputs with name[]=some&name[]=other

Filter by city. Multiple inputs with city[]=Berlin&city[]=Hamburg

Filter by zip. Multiple inputs with zip[]=10115&zip[]=20095

Filter by source. Multiple inputs with source[]=api&source[]=app

Filter by source_external_id. Multiple inputs with source_external_id[]=123&source_external_id[]=456

Center latitude for radius-based geo filter. Requires lng and radius.

Center longitude for radius-based geo filter. Requires lat and radius.

Radius in meters for geo filter. Requires lat and lng.