Consultar dados de uma pessoa

Aqui você pode consultar os dados de uma pessoa via ID ou Username, trazendo todos os dados cadastrados dessa pessoa

Assista como é realizada a conexão dessa API no vídeo abaixo.

Como consultar os dados de uma pessoa utilizando API e o código identificador da pessoa (userId)?

Você pode consultar os dados de cadastro de uma pessoa específica no Zeev utilizando API e o código identificador da pessoa (userId). Siga os passos abaixo:

1. Obtenha o UserId: Obtenha o código identificador da pessoa. Ele pode ser encontrado na página de cadastro de usuários em Acesso > Pessoas, ou pode ser obtido como retorno de alguma consulta de API identificado como por exemplo em consultar de solicitações (na propriedade requester > id ) ou em muitos outros.

2. Autenticação: Obtenha um token de autenticação com permissão de realizar essa operação.

3. Enviar a Requisição: Utilize o endpoint Consultar dados de uma pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select.

Obter pessoa por código (Auth)

get

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

idinteger · int32Opcional

Código identificador da pessoa

namestringOpcional

Nome da pessoa

emailstringOpcional

Endereço de e-mail para notificações

usernamestringOpcional

Username da pessoa

documentstringOpcional

Documento de CPF ou CNPJ

identificationstringOpcional

Matrícula ou número interno da pessoa

isActivebooleanOpcional

Indicador se a pessoa está ativa

isSuperAdminbooleanOpcional

Indicador se a pessoa é superadministradora

isLockedbooleanOpcional

Indicador se a pessoa está bloqueada

isAbsentbooleanOpcional

Indicador se a pessoa está em ausência

authenticationTypestringOpcional

Tipo de autenticação da pessoa

licenseTypestringOpcional

Tipo de licença da pessoa

createDatestring · date-timeOpcional

Data de criação da pessoa

lastLoginDatestring · date-timeOpcional

Data de último login da pessoa

lastPasswordChangestring · date-timeOpcional

Data da última troca de senha da pessoa

isPasswordExpiredbooleanOpcional

isPasswordRequiredbooleanOpcional

isAnonymousbooleanOpcional

isSubstituteNowbooleanOpcional

businessShiftIdinteger · int32Opcional

Código identificador do turno de trabalho

400

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

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

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

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

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

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/users/{userid}

HTTPcURLJavaScriptPython

GET /api/2/users/{userid} 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-03-24T06:55:40.561Z",
  "lastLoginDate": "2026-03-24T06:55:40.561Z",
  "lastPasswordChange": "2026-03-24T06:55:40.561Z",
  "isPasswordExpired": true,
  "isPasswordRequired": true,
  "isAnonymous": true,
  "isSubstituteNow": true,
  "businessShiftId": 1,
  "isSubstituteFor": [
    {
      "id": 1,
      "name": "text",
      "username": "text",
      "email": "text",
      "isActive": true,
      "isAbsent": true
    }
  ],
  "substitute": {
    "id": 1,
    "name": "text",
    "username": "text",
    "email": "text",
    "isActive": true,
    "isAbsent": true
  },
  "groups": [
    {
      "id": 1,
      "name": "text",
      "default": "text"
    }
  ],
  "positions": [
    {
      "id": 1,
      "position": {
        "id": 1,
        "code": "text",
        "name": "text",
        "level": "text"
      },
      "team": {
        "id": 1,
        "code": "text",
        "name": "text",
        "sign": "text",
        "level": "text"
      }
    }
  ],
  "leadership": {
    "id": 1,
    "name": "text",
    "username": "text",
    "email": "text"
  }
}

Exemplo de como obter os dados de uma pessoa utilizando API e userId

Node.js

let userId = 379;

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/${userId}`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

/*
Se desejar modifique a URL para incluir consulta oData
e retornar apenas as propridades de que precisa no resultado
veja o exemplo abaixo
*/

let urlAddress = `https://seu_endereco.do.zeev/api/2/users/${userId}`;
urlAddress = `${urlAddress}?$select=name,email`;

// Ao utilizar o endereço acima na requisição, o corpo de resposta trará apenas o nome e o e-mail do usuário

---

Vídeo de exemplo de uso

Como consultar os dados de uma pessoa utilizando API e o login de usuário da pessoa (username)?

Você pode consultar os dados de cadastro de uma pessoa específica no Zeev utilizando API e o login de usuário da pessoa (username), para isso, siga os passos abaixo:

1. Obtenha o UserId: Obtenha o código identificador da pessoa, ele pode ser encontrado na página de cadastro de usuários em Acesso > Pessoas, ou pode ser obtido como retorno de alguma consulta de API identificado como por exemplo em consultar de solicitações (na propriedade requester > name) ou em muitos outros.

2. Autenticação: Obtenha um token de autenticação com permissão de realizar essa operação.

3. Enviar a Requisição: Utilize o endpoint Consultar dados de uma pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select.

Além do uso do endpoint indicado no exemplo abaixo [Route("{username}")], está disponível uma rota com o seguinte endereço [Route("username/{username}")].

Obter pessoa por username (Auth)

get

Autorizações

Bearer

AuthorizationstringObrigatório

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

Parâmetros de rota

usernamestringObrigatório

Descrição do username da pessoa

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

idinteger · int32Opcional

Código identificador da pessoa

namestringOpcional

Nome da pessoa

emailstringOpcional

Endereço de e-mail para notificações

usernamestringOpcional

Username da pessoa

documentstringOpcional

Documento de CPF ou CNPJ

identificationstringOpcional

Matrícula ou número interno da pessoa

isActivebooleanOpcional

Indicador se a pessoa está ativa

isSuperAdminbooleanOpcional

Indicador se a pessoa é superadministradora

isLockedbooleanOpcional

Indicador se a pessoa está bloqueada

isAbsentbooleanOpcional

Indicador se a pessoa está em ausência

authenticationTypestringOpcional

Tipo de autenticação da pessoa

licenseTypestringOpcional

Tipo de licença da pessoa

createDatestring · date-timeOpcional

Data de criação da pessoa

lastLoginDatestring · date-timeOpcional

Data de último login da pessoa

lastPasswordChangestring · date-timeOpcional

Data da última troca de senha da pessoa

isPasswordExpiredbooleanOpcional

isPasswordRequiredbooleanOpcional

isAnonymousbooleanOpcional

isSubstituteNowbooleanOpcional

businessShiftIdinteger · int32Opcional

Código identificador do turno de trabalho

400

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

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

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

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

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

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/users/{username}

HTTPcURLJavaScriptPython

GET /api/2/users/{username} 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-03-24T06:55:40.561Z",
  "lastLoginDate": "2026-03-24T06:55:40.561Z",
  "lastPasswordChange": "2026-03-24T06:55:40.561Z",
  "isPasswordExpired": true,
  "isPasswordRequired": true,
  "isAnonymous": true,
  "isSubstituteNow": true,
  "businessShiftId": 1,
  "isSubstituteFor": [
    {
      "id": 1,
      "name": "text",
      "username": "text",
      "email": "text",
      "isActive": true,
      "isAbsent": true
    }
  ],
  "substitute": {
    "id": 1,
    "name": "text",
    "username": "text",
    "email": "text",
    "isActive": true,
    "isAbsent": true
  },
  "groups": [
    {
      "id": 1,
      "name": "text",
      "default": "text"
    }
  ],
  "positions": [
    {
      "id": 1,
      "position": {
        "id": 1,
        "code": "text",
        "name": "text",
        "level": "text"
      },
      "team": {
        "id": 1,
        "code": "text",
        "name": "text",
        "sign": "text",
        "level": "text"
      }
    }
  ],
  "leadership": {
    "id": 1,
    "name": "text",
    "username": "text",
    "email": "text"
  }
}

Node.js

let userName = 'Jhony';

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/${userName}`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

/*
Se desejar modifique a URL para incluir consulta oData
e retornar apenas as propridades de que precisa no resultado
veja o exemplo abaixo
*/

let urlAddress = `https://seu_endereco.do.zeev/api/2/users/${userId}`;
urlAddress = `${urlAddress}?$select=name,email`;

// Ao utilizar o endereço acima na requisição, o corpo de resposta trará apenas o nome e o e-mail do usuário