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

# Get users

`GET /users`

## Request

- Base URL: `https://connect.clever.gy`
- URL: `https://connect.clever.gy/users`
- Auth: API key in header `clevergy-api-key`

Returns a paginated list of users filtered by a given criteria. If no filter
parameter is included (nif, email), all the tenant users shall be returned.

## Query parameters

- `page` integer
- `size` integer
- `sort` 'id' | 'name' | 'surname' | 'email' | 'nif'
- `direction` 'ASC' | 'DESC'
- `nif` string
- `email` string

## Response `200`

paginated list of users

- UsersPage: Paginated list of users
  - `size` integer, required: Number of elements in the page requested
  - `page` integer, required: Number of the page requested
  - `totalPages` integer, required: Number of total pages
  - `totalElements` integer, required: Number of total elements in the list
  - `elements` UsersPageElement[], required: List of users
    - `id` string
    - `name` string
    - `surname` string
    - `email` string
    - `nif` string

## Other responses

- `400`: Incorrect sort criteria or no filter parameter provided
- `401`: Unauthorized
- `default`: Unexpected error

---

[API](https://skmtc.dev/clevergy/apis/clevergy-connect-api.md) - [All operations](https://skmtc.dev/clevergy/apis/clevergy-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clevergy/apis/clevergy-connect-api/revisions/d333c5eecb5b?raw)