Listar pessoas

Essa API funciona para você, que precisa trazer informações sobre usuários cadastrados no seu ambiente do Zeev.

Assista ao uso dessa API com exemplos no final dessa página.

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

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de consulta

pageNumberinteger · int32Opcional

Número da página de registros

isActivebooleanOpcional

Indicador true ou false se pessoa ativa

Respostas

200

Sucesso.

idinteger · int32Opcional

Identificador da pessoa

namestringOpcional

Nome da pessoa

emailstringOpcional

Endereço de e-mail da pessoa

usernamestringOpcional

Login da pessoa

documentstringOpcional

CPF/CNPJ

identificationstringOpcional

Matrícula

isActivebooleanOpcional

Indica se o cadastro da pessoa está ativo

isSuperAdminbooleanOpcional

Indica se é super administrador

isLockedbooleanOpcional

Indica se o acesso da pessoa está bloqueado por tentativas de login inválido

isAbsentbooleanOpcional

Indica se a pessoa está em período de ausência temporária

authenticationTypestringOpcional

Tipo de autenticação

licenseTypestringOpcional

createDatestring · date-timeOpcional

Data em que a pessoa foi cadastrada

lastLoginDatestring · date-timeOpcional

Data o último login da pessoa

lastPasswordChangestring · date-timeOpcional

Data em que a senha foi alterada pela ultima vez

businessShiftIdinteger · int32Opcional

Código identificador do turno de trabalho

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

get/api/2/users

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": "2026-01-01T00:00:00.000Z",
    "lastLoginDate": "2026-01-01T00:00:00.000Z",
    "lastPasswordChange": "2026-01-01T00:00:00.000Z",
    "businessShiftId": 1,
    "leadership": {
      "id": 1,
      "name": "text",
      "username": "text",
      "email": "text"
    }
  }
]

Exemplos de consulta de pessoas utilizando API

Node.js

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`;

---

Vídeo de exemplo de uso

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• Como listar, filtrar e editar pessoas