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

# Listing users

`GET /users`

Returns a list of company users.

## Query parameters

- `id` number
- `email` string
- `departmentId` number
- `roleId` number
- `profileTestEnabled` boolean
- `type` 'root' | 'owner' | 'guest'
- `profileTestStatus` boolean
- `testStatus` boolean
- `taxpayerRegistry` string
- `countryOfOrigin` string
- `code` number
- `fields` string
- `perPage` integer
- `page` integer

## Response `200`

An array of departments

- PaginatedUser — An array of users
  - `results` User[], required
    - `id` integer, required — User ID
    - `name` string, required — User name
    - `email` string — User email
    - `departmentId` integer — Id from department from whose the user belongs
    - `roleId` integer — Id from role from whose the user belongs
    - `profileTestEnabled` boolean — Checks if user must make profile tests
    - `type` 'root' | 'owner' | 'guest' — Kind of user
    - `code` string, required — User identifier
    - `taxpayerRegistry` string — User taxpayer registry
    - `countryOfOrigin` string — User origin country
    - `accessProfileId` number — Id from access profile
    - `branchIds` integer[] — List of company branches IDs associated to the user
    - `createdAt` string, date-time, required — Data of creation
    - `updatedAt` string, date-time, required — Date of update
  - `totalResults` integer
  - `page` integer
  - `totalPages` integer

## Other responses

- `400` — BadRequest / Invalid Input
- `401` — Unauthorized
- `403` — Forbidden

---

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