Pular para o conteúdo
Olist Ecommerce

Retorna os usuários cadastrados no Admin

GET
/api/v2/users

Authorizations

Seção intitulada “Authorizations ”

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

OK

Array<object>
object
id

Código identificador do usuário

integer
email

Email do usuário

string format: email
access_token

Token de validação de usuário logado (access_token)

O access_token é gerado quando o usuário loga no Admin

string
name

Nome do usuário

string
nullable
admin

Identificador de usuários administradores

Esse atributo retorna true para um usuário administrador do ambiente de loja

boolean
renew_password

Identificador de usuários que atualizaram a senha inicial

Esse atributo retorna true para um usuário que já redefiniu sua senha pelo menos uma vez

boolean
role

Código da função do usuário na loja:

  • Agente: 0;
  • Gestor: 1;
  • Local: 2;
  • Agente Social Selling: 3.
integer
tags

Tags para agrupamento de usuários As tags podem ser são utilizadas para direcionar promoções para determinados usuários, organizar os recebedores em uma divisão de pagamentos, definir regras de comissão

Array<string>
external_code

Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema.

string
nullable
phone_area

Código de Discagem Direta a Distância (DDD) do telefone do usuário

string
>= 2 characters <= 2 characters
phone

Número de telefone do usuário

string
>= 8 characters <= 9 characters
created_at

Data de inclusão do usuário no Admin

string format: date-time
updated_at

Data de atualização das informações do usuário

string format: date-time
Example
[
  {
    "id": 1,
    "email": "foo@vnda.com.br",
    "name": "User 1",
    "admin": true,
    "renew_password": true,
    "role": 1,
    "access_token": "706a99d0706a99d070006a99d0706a99d0706a99d0706a99d0706a99d0706a99d0",
    "tags": [],
    "external_code": null,
    "created_at": "2019-11-06T08:50:37.130-03:00",
    "updated_at": "2020-03-26T10:40:33.730-03:00"
  },
  {
    "id": 1,
    "email": "test@vnda.com.br",
    "name": "User 2",
    "admin": false,
    "renew_password": false,
    "role": 2,
    "access_token": "706a99d0706a99dhgs070006a99d0706a99d0706a99d0706a99d0706a99d0706a99d0",
    "tags": [],
    "external_code": null,
    "created_at": "2019-12-06T08:50:37.130-03:00",
    "updated_at": "2020-04-26T10:40:33.730-03:00"
  }
]

401

Seção intitulada “401 ”

Token de acesso inválido

404

Seção intitulada “404 ”

Domínio da loja inválido

404

Domínio de loja não encontrado

object
error
required
string
Allowed values: not found