Lista os usuários

GET

/api/v2/users

• Servidor do ambiente de produção
• Servidor do ambiente de testes

Lista os usuários

Authorizations

• Token
• X-Shop-Host

Parameters

Query Parameters

include_inactive

boolean

Incluir usuários desativados?

include_images

boolean

Incluir todas as imagens dos produtos?

external_code

string

Exibe somente os usuários com o código externo indicado

role_name

string

Allowed values: Agente Gestor Local

Exibe somente os usuários com a função indicada

term

string

Filtra usuários que contenham o valor indicado no nome, telefone, email ou código externo

Responses

200

Quando os usuários são listados

Array<object>

User

Modelo que representa um usuário na API

object

id

integer

email

required

string format: email

access_token

string

name

string

nullable

admin

boolean

renew_password

boolean

role

integer

tags

Array<string>

external_code

string

nullable

phone_area

string

>= 2 characters <= 2 characters

phone

string

>= 8 characters <= 9 characters

created_at

string format: date-time

updated_at

string format: date-time

Examples

[
  {
    "id": 1,
    "email": "foo@vnda.com.br",
    "name": null,
    "admin": false,
    "renew_password": false,
    "role": 1,
    "access_token": "706a99d0706a99d0706a99d0706a99d0706a99d0706a99d0706a99d0706a99d0",
    "tags": [],
    "external_code": null,
    "created_at": "2019-11-06T08:50:37.130-03:00",
    "updated_at": "2020-03-26T10:40:33.730-03:00"
  }
]