v1

latestOpenAPI 3.0.02026-08-06151101754.7 KB
Employees

Returns employees

get/employees

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

group_idinteger

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

picture_idinteger

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

first_namestring

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

last_namestring

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

emailstring

Filter by email. Multiple inputs with email=some@example.com&email=other@example.com

phonestring

Filter by phone.

mobilestring

Filter by mobile.

skillsstring

Filter by skills.

infostring

Filter by info.

locale'de_DE' | 'en_US' | 'pl_PL' | 'uk_UA' | 'ro_RO' | 'es_ES'

Filter by locale. Multiple inputs with locale[]=de_DE&locale[]=en_US

numberstring

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

positionstring

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

departmentstring

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

inactiveboolean

Filter by inactive.

driver_licenseboolean

Filter by driver_license.

truck_licenseboolean

Filter by truck_license.

assignmentsinteger

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

absencesinteger

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

notesinteger

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

latnumber float

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

lngnumber float

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

radiusinteger

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

Response

Employees list

OR
OR

Example response

{
  "data": [
    {
      "id": 1,
      "first_line": "John Doe",
      "custom_number": "E-101",
      "picture_id": 1,
      "group_id": 1,
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "email": "john.doe@example.com",
      "phone": "+49123456789",
      "mobile": "+49987654321",
      "street": "Main Street 1",
      "zip": "12345",
      "city": "Berlin",
      "province": "Berlin",
      "country": "DE",
      "lat": 52.520007,
      "lng": 13.404954,
      "number": "E-101",
      "position": "Developer",
      "department": "IT",
      "skills": "Woodworking, Plumbing",
      "holidays_per_year": 25.5,
      "driver_license": true,
      "initials": "JD",
      "picture_is_avatar": true,
      "icon": "fa-user",
      "color": "#FF5733",
      "contrast_color": "dark",
      "locale": "de_DE",
      "timezone": "Europe/Berlin",
      "info": "Some extra info",
      "source": "manual"
    }
  ]
}