---
title: "Listar Usuários"
method: GET
path: "/users/"
tags: ["Usuário"]
---

# Listar Usuários

`GET /users/`

Retorna Lista de Usuários

## Query parameters

- `secret` string, required
- `cursor` string
- `q` string

## Response `200`

Lista de Usuários

- object
  - `next_cursor` string — Cursor para a próxima página de resultados
  - `prev_cursor` string — Cursor para a página anterior de resultados
  - `results` object[]
    - `id` integer — Identificador do usuário
    - `metadata` object — Dados extras no formato chave-valor para esse usuário - as chaves habilitadas para cadastro nesse campo precisam ser previamente registradas pelo Admin
    - `is_pre_registration` boolean — Quando 'true' indica que esse usuário é um pré-registro, quando 'false' o usuário realizou seu primeiro login e definiu sua senha
    - `mobile_internet_allowed` boolean — Quando 'false' o aplicativo não utilizará internet móvel do dispositivo
    - `times_allowed` object — Grade de horários permitidos para o uso no aplicativo - quando 'null' não há restrições
    - `created_at` string, date-time — Data/hora de criação do usuário
    - `created_at_i18n` string — Data/hora de criação do usuário em formato local
    - `blocked` boolean — Quando 'true' esse usuário não pode acessar o conteúdo da Gupy
    - `name` string — Nome do usuário
    - `shrot_name` string — Nome abreviado do usuário
    - `nin` string — National Identification Number (CPF para usuários brasileiros)
    - `email` string — E-mail do usuário
    - `id_numbe` string — Identity Number (RG para usuários brasileiros), para recuperação de senha em login baseado em CPF - após definido para um usuário ativo não pode ser redefinido
    - `birth_date` string, date-time — Data de nascimento do usuário no formato YYYY-MM-DD
    - `birth_date_i18n` string — Data de nascimento do usuário em formato local

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[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/revisions/3f26defa2a42/schema)