---
title: "Retrieve a list of Users"
method: GET
path: "/v2/users"
tags: ["Users"]
---

# Retrieve a list of Users

`GET /v2/users`

Retrieves a paginated list of Users.

## Query parameters

- `pageSize` number
- `page` number

## Headers

- `Authorization` string, required

## Response `200`

A paginated list of Users.

- ResponseUsersV2Dto
  - `pageSize` number — The maximum number of items returned per page.
  - `page` number — The current page number.
  - `totalResults` number — The total number of results.
  - `hasMore` boolean — Whether there are more results.
  - `data` ResponseUserV2Dto[] — A list of Users.
    - `id` string — The ID of the user (prefix `USR-`).
    - `name` string — The name of the user.
    - `emailAddress` string — The email address of the user.
    - `cellPhone` string — The phone number of the user.
    - `address` string — The address of the user.
    - `role` string — The role of the user.
    - `fieldTech` boolean — Whether the user is a field technician and can be assigned to jobs.
    - `active` boolean — Whether the user is active.
    - `notes` string — Notes about the user.
    - `jobTypes` ResponseGenericJobTypeV2Dto[] — The job types assigned to the user. An empty array means the user is assigned to all job types.
      - `id` string — The ID of the job type (prefix `JT-`).
      - `name` string — The name of the job type.
    - `serviceAreas` ResponseGenericServiceAreaV2Dto[] — The service areas of the user.
      - `id` string — The ID of the service area (prefix `SA-`).
      - `name` string — The name of the service area.

## Other responses

- `401` — Missing or invalid authentication token.

---

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