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

# Get users

`GET /v2/users`

Get a list of users.

## Query parameters

- `offset` integer
- `limit` integer
- `role` 'basic' | 'plus' — User role.
- `allow_camera` boolean
- `active` boolean
- `search` string

## Response `200`

- object
  - `offset` integer — The number of items to skiped before starting to collect the result set.
  - `limit` integer — The numbers of items to returned.
  - `has_more` boolean — Indicates is there more values.
  - `count` integer — Total number of values returned.
  - `users` object[]
    - `id` string — User Id.
    - `role` string — User role.
    - `allow_camera` boolean — Indicates if user is allowed to do video call or not.
    - `language` string — User language.
    - `creation_date` string, date-time — Creation date of the user.
    - `avatar_url` string — Avatar resource url of the user. **The file pointed by this URL is treated as PII/PHI**
    - `active` boolean — Indicates if the user active or not.

## Other responses

- `401` — Unauthorized
- `429` — Too Many request

---

[API](https://skmtc.net/kaleyra/apis/kaleyra-io-sms-apis.md) · [All operations](https://skmtc.net/kaleyra/apis/kaleyra-io-sms-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kaleyra/kaleyra-io-sms-apis/versions/d9b785884d03/schema)
