# Lista usuários da conta

Retorna uma lista com os usuários da conta.

Endpoint: GET /users
Version: 2.1
Security: BasicAuth

## Query parameters:

  - `max_results` (integer)
    Tamanho da página de resultados paginados.

  - `page` (integer)
    Número da página de resultados a retornar

## Response 200 fields (application/json):

  - `_items` (array)

  - `_items._id` (string)
    Identificador único do recurso, gerado internamente.

  - `_items._created` (string)
    Example: "2024-09-09T08:00-03:00"

  - `_items._updated` (string)
    Example: "2024-09-09T08:00-03:00"

  - `_items.full_name` (string)
    Nome completo.
    Example: "Exemplo da Silva"

  - `_items.email` (string)
    Endereço de e-mail.
    Example: "exemplo@tiquetaque.com"

  - `_items.mobile_phone` (string)
    Número de telefone celular com código de área, somente números.
    Example: "11991234567"

  - `_items.external_id` (string)
    Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

  - `_items.intercom_chat` (boolean)
    Indica se o chat do intercom no TiqueAdmin está habilitado para este usuário.

  - `_items.verified_user` (boolean)
    Indica se a conta do usuário já foi verificada através do email de ativação.
    Example: true

  - `_items.role` (string)
    Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]
 - admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema,  como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões;  lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.
 - admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador,  porém apenas para as unidades selecionadas.
 - supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.
 - read-only: Pode apenas: visualizar os dados das unidades selecionadas.
    Example: "admin-supervisor"

  - `_items.allowed_sites` (array)
    Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública  o recurso de unidades, isto será adicionado futuramente.
    Example: ["id_1","id_2"]

  - `_items.permissions` (object)
    Configurações de permissões de usuário.

  - `_items.permissions.allow_ws_edition` (boolean)
    Indica se o usuário pode editar escalas, apenas aplicável quando role = 'supervisor'

  - `_links` (object)

  - `_links.parent` (object)

  - `_links.parent.href` (string)

  - `_links.parent.title` (string)

  - `_links.self` (object)

  - `_meta` (object)

  - `_meta.max_results` (integer)

  - `_meta.page` (integer)

  - `_meta.total` (integer)

## Response 401 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.

## Response 404 fields (application/json):

  - `_code` (integer)
    Código de erro interno.

  - `_status` (string)
    Example: "ERR"

  - `_error` (object)

  - `_error.code` (integer)
    Codigo de erro HTTP.

  - `_error.message` (string)
    Mensagem de erro interna.

  - `_error._ui_message` (string)
    Mensagem de erro para o usuário.