YAyampi
Usuários

Visualizar detalhes de um usuário

Changed on

Visualiza os detalhes de uma determinado usuário a partir do seu ID

get/{alias}/users/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/users/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do usuário

Response

Detalhes do usuário

idinteger

ID do usuário.

activeboolean

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

namestring

Nome completo do usuário.

social_namestring nullable

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

emailstring email

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

temporary_emailstring email nullable

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_ownerboolean

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

agreeboolean

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

merchant_ownerboolean

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

super_userboolean

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

last_login_atstring date-time

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

avatar_urlstring 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_notificationsboolean

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

typestring

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_timestampinteger

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

confirmed_atstring date-time

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

mfa_enabledboolean

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

cpfstring

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

birthdaystring date

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

phonestring

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

address_streetstring nullable

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

address_numberstring nullable

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

address_neighborhoodstring nullable

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

address_complementstring nullable

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

address_citystring nullable

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

address_statestring nullable

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

address_zipcodestring nullable

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

Example response

{
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-06-23 08:05:17",
    "timezone": "America/Sao_Paulo"
  },
  "merchants": {
    "data": [
      {
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    ]
  }
}

Changes