Skip to main content
POST
Visualizar dados do usuário logado

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Response

Dados do usuário logado

Informações de um usuário.

id
integer

ID do usuário.

active
boolean

Indica se o usuário está ativo e pode acessar o painel da loja.

name
string

Nome completo do usuário.

social_name
string | null

Nome social do usuário, exibido no lugar do nome de registro quando preenchido.

email
string<email>

E-mail do usuário, usado como login de acesso ao painel.

temporary_email
string<email> | null

E-mail informado pelo usuário que ainda aguarda confirmação, preenchido durante o cadastro e nas solicitações de troca de e-mail.

is_owner
boolean

Indica se o usuário autenticado é o dono da loja em contexto.

agree
boolean

Indica se o usuário aceitou os termos de uso da Yampi.

merchant_owner
boolean

Indica se este usuário é o dono da loja em contexto.

super_user
boolean

Indica se o usuário possui perfil interno de super usuário da Yampi.

last_login_at
string<date-time>

Data e hora do acesso anterior do usuário, desconsiderando o login atual.

avatar_url
string<uri>

URL da foto de perfil do usuário; quando não houver foto cadastrada, é retornada a imagem do Gravatar vinculada ao e-mail.

allow_notifications
boolean

Indica se o usuário optou por receber notificações da Yampi.

type
string

Tipo do usuário: lead para cadastros de onboarding ainda não convertidos em conta e oauth para usuários criados por aplicativos via OAuth.

created_at
object
created_at_timestamp
integer

Data de criação do usuário em timestamp Unix.

updated_at
object
confirmed_at
string<date-time>

Data e hora em que o usuário confirmou o e-mail de cadastro.

mfa_enabled
boolean

Indica se o usuário tem a autenticação em duas etapas ativa. Retornado apenas para o próprio usuário autenticado.

cpf
string

CPF do usuário. Retornado apenas para o próprio usuário autenticado.

birthday
string<date>

Data de nascimento do usuário. Retornada apenas para o próprio usuário autenticado.

phone
string

Telefone de contato do usuário. Retornado apenas para o próprio usuário autenticado.

address_street
string | null

Nome da rua do endereço do usuário. Retornado apenas para o próprio usuário autenticado.

address_number
string | null

Número do endereço do usuário. Retornado apenas para o próprio usuário autenticado.

address_neighborhood
string | null

Bairro do endereço do usuário. Retornado apenas para o próprio usuário autenticado.

address_complement
string | null

Complemento do endereço do usuário. Retornado apenas para o próprio usuário autenticado.

address_city
string | null

Cidade do endereço do usuário. Retornada apenas para o próprio usuário autenticado.

address_state
string | null

Unidade federativa (estado) do endereço do usuário. Retornada apenas para o próprio usuário autenticado.

address_zipcode
string | null

CEP do endereço do usuário. Retornado apenas para o próprio usuário autenticado.

merchants
object
group
object

Grupo de permissões do usuário na loja em contexto.

notification_types
object

Tipos de notificação que o usuário optou por receber.

lead_data
object

Dados de onboarding vinculados ao usuário.