v1

latestOpenAPI 3.1.02026-08-044330906.8 KB

Retorna todos os usuários

Lista de usuários

get/usuarios

Query parameters

paginainteger

Página da lista (padrão: 1)

quantidadeRegistrosinteger

Quantidade de registros que deverão retornar (max: 50)

dataInicialstring date

Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)

dataFinalstring date

Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)

enumTipoFiltroData'DataAlteracao' | 'DataCriacao'

Tipo de filtro de data

aprovadoboolean

Status de aprovação

cpfstring

CPF do usuário (apenas dígitos serão considerados na filtragem)

Response

200

usuarioIdinteger

bloqueadoboolean

tipoPessoastring

origemContatostring

tipoSexostring

nomestring

cpfstring

emailstring

rgstring

telefoneResidencialstring

telefoneCelularstring

telefoneComercialstring

dataNascimentostring

razaoSocialstring

cnpjstring

inscricaoEstadualstring

responsavelstring

dataCriacaostring

dataAtualizacaostring

revendedorboolean

avatarstring

ipstring

aprovadoboolean

Example response

[
  {
    "bloqueado": true,
    "grupoInformacaoCadastral": [
      {
        "chave": "string",
        "valor": "string"
      }
    ],
    "tipoPessoa": "Fisica",
    "origemContato": "Google",
    "tipoSexo": "Undefined",
    "nome": "string",
    "cpf": "string",
    "email": "string",
    "rg": "string",
    "telefoneResidencial": "string",
    "telefoneCelular": "string",
    "telefoneComercial": "string",
    "dataNascimento": "2022-07-20T17:16:24.396Z",
    "razaoSocial": "string",
    "cnpj": "string",
    "inscricaoEstadual": "string",
    "responsavel": "string",
    "dataCriacao": "2022-07-20T17:16:24.396Z",
    "dataAtualizacao": "2022-07-20T17:16:24.396Z",
    "revendedor": true,
    "listaInformacaoCadastral": [
      {
        "chave": "string",
        "valor": "string"
      }
    ],
    "avatar": "string",
    "ip": "string",
    "aprovado": true
  }
]