---
title: "List users"
method: GET
path: "/api/v1/users"
tags: ["Users"]
---

# List users

`GET /api/v1/users`

## Query parameters

- `filter[email]` string
- `filter[employee_number]` string
- `filter[first_name]` string
- `filter[last_name]` string
- `filter[manager_user_id]` integer
- `filter[must_reset_password]` boolean
- `filter[form_name]` string
- `filter[process_name]` string
- `filter[roles]` string
- `filter[terminated]` boolean
- `filter[username]` string
- `filter[current_login_at_min]` string
- `filter[current_login_at_max]` string
- `filter[hire_date_min]` string
- `filter[hire_date_max]` string
- `filter[review_archive_date_min]` string
- `filter[review_archive_date_max]` string
- `filter[terminated_date_min]` string
- `filter[terminated_date_max]` string
- `filter[welcome_email_sent_at_min]` string
- `filter[welcome_email_sent_at_max]` string
- `sort` string
- `include` string
- `page[number]` integer
- `page[size]` integer

## Headers

- `Content-Type` string, required

## Response `200`

Success

- object
  - `links` object
  - `data` object[]
    - `type` string
    - `id` string
    - `attributes` object
      - `employee_number` string
      - `username` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `hire_date` string
      - `base_date` string
      - `current_login_at` string
      - `must_reset_password` boolean
      - `welcome_email_sent_at` string
      - `terminated` boolean
      - `terminated_date` string
      - `roles` unknown[]
        - unknown
      - `manager_user_id` integer
      - `form_name` string
      - `process_name` string
      - `review_archive_date` string
      - `locale_format` string
      - `locale_lang` string
    - `relationships` object
      - `groups` object
        - `data` object[]
          - `type` string
          - `id` string
        - `links` object
          - `self` string
  - `included` object[]
    - `type` string
    - `id` string
    - `attributes` object
      - `id` string
      - `name` string
  - `jsonapi` object
    - `version` string

## Other responses

- `400` — Bad Request
- `401` — Invalid token

---

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