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

# Get employees

`GET /employees`

## Query parameters

- `filter[account.email]` string
- `filter[accountId]` integer
- `filter[admin]` boolean
- `filter[employeeId]` integer
- `filter[manager]` boolean
- `filter[segmentIds]` integer[]

## Response `200`

A [JSONAPI resource](http://jsonapi.org/format/#document-resource-objects) containing an array of 'employees' objects

- object
  - `data` Employees[]
    - `type` string
    - `id` string
    - `attributes` object
      - `identifier` string
      - `firstName` string
      - `lastName` string
      - `name` string
      - `avatar` string
      - `employmentStart` string
      - `external` boolean
    - `relationships` object
      - `account` object
        - `data` ResourceIdentifier
          - `type` string
          - `id` string
  - `included` ResourceIdentifier[] — An array of included JSONAPI resources
    - `type` string
    - `id` string

---

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