Sign in

v1

latestOpenAPI 3.0.02026-08-06151101754.7 KB
Customers

Returns customers

get/customers

Query parameters

idinteger

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

per_pageinteger

Number of items per Page

pageinteger

Result Page

order_bystring

Order column

order_direction'asc' | 'desc'

Order direction. asc or desc possible

returnstring

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.

group_bystring

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.

withstring

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

excludeinteger

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

qstring

Search string

namestring

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

name_addonstring

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

customer_numberstring

Filter by customer_number. Multiple inputs with customer_number[]=101&customer_number[]=102

infostring

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

sourcestring

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

source_external_idstring

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

projectsinteger

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

addressesinteger

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

Response

Customers list

OR
OR

Example response

{
  "data": [
    {
      "id": 1,
      "first_line": "Craftboxx GmbH",
      "icon": "fa-user-tie",
      "custom_number": "C-1001",
      "name": "Craftboxx GmbH",
      "name_addon": "HQ",
      "customer_number": "C-1001",
      "info": "Important customer",
      "source": "manual"
    }
  ]
}