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

# GET /users

`GET /users`

Returns a list of users. The list can be filtered by first name, last name or email.

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `sortField` 'firstName' | 'lastName' | 'createdAt'
- `filterUserType` 'contractor' | 'time_sheet_only' | 'field_worker' | 'apprentice' | 'tradesman' | 'advisor' | 'full_user'
- `filterStatus` 'active' | 'disabled' | 'invited'
- `filterSearchText` string

## Response `200`

Successful Response

- UsersResponse
  - `result` string, required
  - `data` object[], required
    - `id` number, required
    - `companyId` number, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `email` string, required
    - `userType` 'contractor' | 'time_sheet_only' | 'field_worker' | 'apprentice' | 'tradesman' | 'advisor' | 'full_user', required
    - `createdAt` string, date-time, required
    - `modifiedAt` string, date-time, required
    - `address` AddressContact, required
      - `id` number, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `addressSuburb` string, nullable, required
      - `addressCity` string, nullable, required
      - `addressRegion` string, nullable, required
      - `addressPostcode` string, nullable, required
      - `addressCountry` string, nullable, required
    - `payRate` number, nullable, required — The user's pay rate. Null for callers without the EDIT_EMPLOYEE_RATES permission.
    - `chargeOutRate` number, nullable, required — The user's charge-out rate. Null for callers without the EDIT_EMPLOYEE_RATES permission.
    - `status` 'active' | 'disabled' | 'invited', required
    - `isOwner` boolean, required — Whether this user has owner-level access for the company
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)