Usuários

Pesquisar

<aside>🔒 Para acessar essa rota é necessário ter permissões adequadas.</aside>
get/users

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/users
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros.

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta.

Example:id,login,name,email
filter[id]integer

ID do usuário.

Example:123456
filter[group_id]integer

ID do grupo ao qual o usuário pertence.

Example:3
filter[team_id]integer

ID da equipe a qual o usuário está associado.

Example:5
filter[login]string

Login do usuário.

Example:usuario123
filter[person_id]integer

ID da pessoa associada ao usuário.

Example:56789
filter[name]string

Nome do usuário.

Example:João Silva
filter[name_public]string

Nome para o site.

Example:João Silva
filter[creci]string

CRECI do usuário (para corretor de imóveis).

Example:12345-J
filter[description]string

Descrição do usuário.

Example:Exemplo descrição...
filter[email]string

E-mail do usuário.

Example:email@example.com
filter[phone]string

Telefone do usuário.

Example:(11) 98765-4321
filter[active]boolean

Status do usuário.

Example:true
filter[public]boolean

Mostra no site.

include[calendars]string

Retorna os dados dos calendários criados pelo usuário.

Example:id,name
include[principalCalendar]string

Retorna os dados do calendário do usuário.

Example:id,name
include[systemCalendar]string

Retorna os dados do calendário pelo usuário via sistema.

Example:id,name
include[notifications]string

Retorna os dados das notificações.

Example:id,name
include[group]string

Retorna os dados do grupo ao qual o usuário pertence.

Example:id,name
include[team]string

Retorna os dados da equipe a qual o usuário pertence.

Example:id,name
include[permissionsTable]string

Retorna as permissões que o usuário possui.

Example:permission
include[messages]string

Retorna as mensagens do usuário.

Example:type,message
include[buildings]string

Retorna os imóveis em que o usuário é responsável.

Example:id,title
include[persons]string

Retorna as pessoas que o usuário é responsável.

Example:id,name
include[person]string

Retorna os dados da pessoa vinculada ao usuário.

Example:id,name
include[tickets]string

Retorna os tickets em que o usuário é responsável.

Example:id,name
include[contracts]string

Retorna os contrato.

Example:id,name
include[deals]string

Retorna as negociações que o usuário é responsável.

Example:id,title,status
include[events]string

Retorna os eventos que o usuário está como convidado.

Example:id,title
include[historys]string

Retorna os históricos gerados pelo usuário.

Example:description
include[transactions]string

Retorna as transações do usuário (corretor).

Example:mode,type,description

Changes

No recorded changes to this operation across all 1 revision of this API.