Listar pessoas

Como listar os dados de cadastro de todas as pessoas utilizando API do Zeev?

Para obter os dados de cadastro de pessoas utilizando API, siga os passos abaixo:

  1. Autenticação: Primeiro obtenha um token de autenticação com permissão para acessar esse tipo de informação. Podem existir configurações que limitem o acesso do usuário ao cadastro e o resultado da consulta neste cenário não representaria a lista completa de pessoas cadastradas, como por exemplo o controle de acesso por regras hierárquicas.

  2. Enviar a Requisição: Utilize o endpoint Listar pessoas para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

  3. Paginar: Observe que a consulta à essa API retorna um número limitado de registros; para obter todos os dados, será necessário implementar um algoritmo de paginação

  4. Rate limit: Se for paginar os resultados, respeite os limites máximos de solicitações;;

  5. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $select, $orderby e $top.

Listar as pessoas do sistema (Auth)

get
Autorizações
Parâmetros de consulta
pageNumberinteger · int32Opcional

Número da página de registros

isActivebooleanOpcional

Indicador true ou false se pessoa ativa

Respostas
200

Sucesso.

get
GET /api/2/users HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "email": "text",
    "username": "text",
    "document": "text",
    "identification": "text",
    "isActive": true,
    "isSuperAdmin": true,
    "isLocked": true,
    "isAbsent": true,
    "authenticationType": "text",
    "licenseType": "text",
    "createDate": "2025-08-06T21:21:44.646Z",
    "lastLoginDate": "2025-08-06T21:21:44.646Z",
    "lastPasswordChange": "2025-08-06T21:21:44.646Z",
    "businessShiftId": 1,
    "leadership": {
      "id": 1,
      "name": "text",
      "username": "text",
      "email": "text"
    }
  }
]

Exemplos de consulta de pessoas utilizando API

let pageNumber = 1;
let isActive = true;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users?pageNumber=${pageNumber}&isActive=${isActive}`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

/*
    Além dos parâmetros ja especificados, 
    é possível fazer mais filtros com oData, 
    veja alguns exemplos que podem ser incluidos na requisiço
    e experimente um ou uma combinação deles:
*/
let urlAddress = `https://seu_endereco.do.zeev/api/2/users?pageNumber=${pageNumber}&isActive=${isActive}`;
// - Configurar a requisição para retornar apenas os 100 primeiros registros
urlAddress = `${urlAddress}&$top=100`;
// - Configurar a requisição para retornar apenas as informações de id, nome e e-mail das pessoas
urlAddress = `${urlAddress}&$select=id,name,email`;
// - Configurar a requisição para retornar apenas pessoas cuja o e-mail contenha Zeev
urlAddress = `${urlAddress}&$filter=contains(email,'@zeev')`;
// - Configurar a requisição para retorndar os dados ordenados por data de criação
urlAddress = `${urlAddress}&$orderby=createDate asc`;

Links relacionados:

AnteriorPessoasPróximoConsultar dados de uma pessoa

Atualizado