# Lista de usuários

Retorna lista de usuários.

Endpoint: GET /api/v3/users
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `users_ids` (string)
    Filtro pelos IDs dos usuários. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `name` (string)
    Filtro pelo Nome do usuário.
    Example: "Connectplug"

  - `email` (string)
    Filtro pelo E-mail do usuário.
    Example: "contato@cplug.com.br"

  - `profile_id` (integer)
    Filtro pelo ID do profile.
    Example: 3

  - `companies_ids` (string)
    Filtro pelos IDs das empresas. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.users` (array)
    Representa a lista de usuários

  - `data.users.id` (integer)
    ID do usuário.
    Example: 123

  - `data.users.name` (string)
    Nome do usuário.
    Example: "Fulando usuário"

  - `data.users.username` (string)
    Nome de usuário do usuário.
    Example: "fulano"

  - `data.users.email` (string)
    E-mail do usuário.
    Example: "fulano@email.com"

  - `data.users.profile` (object)
    Perfil do usuário.

  - `data.users.profile.id` (integer)
    Identificador único do perfil.
    Example: 1

  - `data.users.profile.name` (string)
    Nome do perfil.
    Example: "Administrador"

  - `data.users.profile.description` (string)
    Descrição do perfil.
    Example: "Administrador do sistema"

  - `data.users.settings` (object)
    Configurações do usuário.

  - `data.users.settings.notifications` (object)
    Configurações de notificações.

  - `data.users.settings.notifications.receive_financial_emails` (boolean)
    Indica se o usuário pode receber e-mails financeiros.
    Example: true

  - `data.users.settings.notifications.receive_contract_emails` (boolean)
    Indica se o usuário pode receber e-mails de contratos de planos.

  - `data.users.settings.pos` (object)
    Configurações do PDV.

  - `data.users.settings.pos.show_in_list_on_open` (boolean)
    Indica se o usuário pode aparecer na listagem ao abrir o PDV.
    Example: true

  - `data.users.settings.pos.show_in_sellers_list` (boolean)
    Indica se o usuário pode aparecer na lista de vendedores do PDV.
    Example: true

  - `data.users.companies` (array)
    Lista de empresas que permite visualizar.

  - `data.users.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.users.companies.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `data.users.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields