Returns articles

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

Search string

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

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

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

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

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

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

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

Filter by unit_price.

Filter by vat_rate.

Filter by vat_included.

Filter by currency.

Filter by price_date.

Filter by unit. Multiple inputs with unit[]=piece&unit[]=kilogram

Filter by article_url.

Filter by info.

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

Filter by dangerous_material.

Assigned assignments Ids. Multiple inputs with assignments[]=3&assignments[]=6