---
title: "Returns employees"
method: GET
path: "/employees"
tags: ["Employees"]
---

# Returns employees

`GET /employees`

## Query parameters

- `id` integer
- `per_page` integer
- `page` integer
- `order_by` string
- `order_direction` 'asc' | 'desc'
- `return` string
- `group_by` string
- `with` string
- `exclude` integer
- `q` string
- `group_id` integer
- `picture_id` integer
- `first_name` string
- `last_name` string
- `email` string
- `phone` string
- `mobile` string
- `skills` string
- `info` string
- `locale` 'de_DE' | 'en_US' | 'pl_PL' | 'uk_UA' | 'ro_RO' | 'es_ES'
- `number` string
- `position` string
- `department` string
- `inactive` boolean
- `driver_license` boolean
- `truck_license` boolean
- `assignments` integer
- `absences` integer
- `notes` integer
- `lat` number, float
- `lng` number, float
- `radius` integer

## Response `200`

Employees list

- union
  - object — Generic paginated response wrapper
    - `data` object[] — Employees list
      - `id` integer — ID
      - `first_line` string — First line
      - `custom_number` string — Custom number
      - `picture_id` integer — Photo
      - `group_id` integer — Team
      - `first_name` string — First name
      - `last_name` string — Last name
      - `full_name` string — Full name
      - `email` string — Email
      - `password_changed_at` string, date-time — Last password change
      - `phone` string — Landline
      - `mobile` string — Mobile
      - `street` string — Street and no.
      - `zip` string — ZIP code
      - `city` string — City
      - `province` string — State/Province
      - `country` string — Country
      - `lat` number — Latitude
      - `lng` number — Longitude
      - `number` string — Initials / No.
      - `position` string — Job title
      - `department` string — Department
      - `skills` string — Skills
      - `holidays_per_year` number, float — Holiday entitlement this year
      - `holidays_overtake_balances` boolean — Carry over last year's holidays
      - `driver_license` boolean — Driver's license
      - `truck_license` boolean — Truck driver's license
      - `inactive` boolean — Inactive
      - `initials` string — Initials / No.
      - `picture_is_avatar` boolean — Picture is avatar
      - `icon` string — Icon
      - `color` string — Color
      - `contrast_color` 'dark' | 'white' — Contrast color
      - `locale` 'de_DE' | 'en_US' | 'pl_PL' | 'uk_UA' | 'ro_RO' | 'es_ES' — Display language
      - `timezone` string — Timezone
      - `info` string — Additional info
      - `source` string — The source of the employee data
      - `source_external_id` string, nullable — The external ID from the source
      - `created_at` string, date-time — Created
      - `updated_at` string, date-time — Updated
    - `links` object
      - `first` string, nullable
      - `last` string, nullable
      - `prev` string, nullable
      - `next` string, nullable
    - `meta` object
      - `current_page` integer
      - `from` integer, nullable
      - `last_page` integer
      - `links` object[]
        - `url` string, nullable
        - `label` string
        - `active` boolean
      - `path` string
      - `per_page` integer
      - `to` integer, nullable
      - `total` integer
  - AggregateResponse — Returned instead of the paginated list when the "return=" parameter is used.
    - `data` object
      - `count` integer — Response envelope for the "return=" aggregate parameter (see general--return). Exactly one of the properties is present per response, depending on the requested aggregate.
      - `sum` number, nullable
      - `avg` number, nullable
      - `min` unknown
      - `max` unknown
  - GroupedAggregateResponse — Returned instead of the paginated list when the "group_by=" parameter is used. One row per bucket.
    - `data` object[]
      - `count` integer — Response envelope for the "group_by=" parameter (see general--group_by). Each element is one bucket: the grouped column plus the requested aggregate (count by default, or one of sum/min/max/avg via "return=").
      - `sum` number, nullable
      - `avg` number, nullable
      - `min` unknown
      - `max` unknown

## Other responses

- `401` — The request lacks valid authentication credentials.
- `403` — The token is valid but lacks the permission for this action.
- `500` — An unexpected error occurred on the server (e.g. a requested relation does not exist).

---

[API](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation.md) · [All operations](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/craftboxx/craftboxx-api-documentation/revisions/c01f07a02f77/schema)