> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeev/apis/all/access/people/consult.md).

# 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

{% hint style="info" %}
Assista como é realizada a conexão dessa API [**no vídeo abaixo**](#video-de-exemplo-de-uso).
{% endhint %}

## 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](/zeev/apis/all/instances/report.md#como-consultar-solicitacoes-utilizando-as-apis-do-zeev) (na propriedade requester > id ) ou em muitos outros.
2. **Autenticação**: Obtenha um [token de autenticação](/zeev/apis/como-utilizar-as-apis-do-zeev/como-gerar-tokens-para-autenticar-nas-apis.md) com permissão de realizar essa operação.
3. **Enviar a Requisição**: Utilize o endpoint [#api-2-users-userid](#api-2-users-userid "mention") 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](/zeev/apis/como-utilizar-as-apis-do-zeev/como-realizar-filtros-e-manipulacoes-adicionais-nas-apis-com-odata.md) para manipular o resultado da API. Essa API aceita  `$select.`

## Obter pessoa por código (Auth)

> \[<https://kb.stoque.com.br/zeev/apis/all/access/people/consult]\\(https://kb.stoque.com.br/zeev/apis/all/access/people/consult)>

```json
{"openapi":"3.1.1","info":{"title":"API RESTFul versão 2.0 ","version":"2"},"servers":[{"url":"https://seu_endereco.do.zeev"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Utilize um token válido de usuário para realizar a requisição","name":"Authorization","in":"header"}},"schemas":{"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult":{"type":"object","properties":{"id":{"format":"int32","description":"Código identificador da pessoa","type":"integer"},"name":{"description":"Nome da pessoa","type":"string"},"email":{"description":"Endereço de e-mail para notificações","type":"string"},"username":{"description":"Username da pessoa","type":"string"},"document":{"description":"Documento de CPF ou CNPJ","type":"string"},"identification":{"description":"Matrícula ou número interno da pessoa","type":"string"},"isActive":{"description":"Indicador se a pessoa está ativa","type":"boolean"},"isSuperAdmin":{"description":"Indicador se a pessoa é superadministradora","type":"boolean"},"isLocked":{"description":"Indicador se a pessoa está bloqueada","type":"boolean"},"isAbsent":{"description":"Indicador se a pessoa está em ausência","type":"boolean"},"authenticationType":{"description":"Tipo de autenticação da pessoa","type":"string"},"licenseType":{"description":"Tipo de licença da pessoa","type":"string"},"createDate":{"format":"date-time","description":"Data de criação da pessoa","type":"string"},"lastLoginDate":{"format":"date-time","description":"Data de último login da pessoa","type":"string"},"lastPasswordChange":{"format":"date-time","description":"Data da última troca de senha da pessoa","type":"string"},"isPasswordExpired":{"type":"boolean"},"isPasswordRequired":{"type":"boolean"},"isAnonymous":{"type":"boolean"},"isSubstituteNow":{"type":"boolean"},"businessShiftId":{"format":"int32","description":"Código identificador do turno de trabalho","type":"integer"},"isSubstituteFor":{"description":"Lista de outras pessoas para os quais essa pessoa é substituta","type":"array","items":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_Substituting"}},"substitute":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_Substitute","description":"Informações da pessoa substituta deste"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_Groups"}},"positions":{"type":"array","items":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions"}},"leadership":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions+GetUsersDetailedModelResult_Leadership","description":"Informações do gestor imediato desta pessoa"},"countryId":{"format":"int32","description":"Código identificador do país","type":"integer"},"countryName":{"description":"Nome do país","type":"string"},"stateId":{"format":"int32","description":"Código identificador do estado","type":"integer"},"stateName":{"description":"Nome do estado","type":"string"},"stateSymbol":{"description":"Sigla/símbolo do estado","type":"string"},"cityId":{"format":"int32","description":"Código identificador da cidade","type":"integer"},"cityName":{"description":"Nome da cidade","type":"string"},"timezoneAbbreviation":{"description":"Abreviação do fuso horário","type":"string"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_Substituting":{"type":"object","properties":{"id":{"format":"int32","description":"Código identificador da pessoa que está sendo substituída","type":"integer"},"name":{"description":"Nome da pessoa que está sendo substituída","type":"string"},"username":{"description":"Username da pessoa que está sendo substituída","type":"string"},"email":{"description":"Endereço de e-mail da pessoa que está sendo substituída","type":"string"},"isActive":{"description":"Indicador se a pessoa que está sendo substituída está ativa","type":"boolean"},"isAbsent":{"description":"Indicador se a pessoa que está sendo substituída está ausente","type":"boolean"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_Substitute":{"type":"object","properties":{"id":{"format":"int32","description":"Código identificador da pessoa substituta","type":"integer"},"name":{"description":"Nome da pessoa substituta","type":"string"},"username":{"description":"Username da pessoa substituta","type":"string"},"email":{"description":"Endereço de e-mail da pessoa substituta","type":"string"},"isActive":{"description":"Indicador se a pessoa substituta está ativa","type":"boolean"},"isAbsent":{"description":"Indicador se a pessoa substituta está ausente","type":"boolean"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_Groups":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"default":{"type":"string"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"position":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions+GetUsersDetailedModelResult_UserPositions_Positions"},"team":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions+GetUsersDetailedModelResult_UserPositions_Areas"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions+GetUsersDetailedModelResult_UserPositions_Positions":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"code":{"type":"string"},"name":{"type":"string"},"level":{"type":"string"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions+GetUsersDetailedModelResult_UserPositions_Areas":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"code":{"type":"string"},"name":{"type":"string"},"sign":{"type":"string"},"level":{"type":"string"}}},"Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult+GetUsersDetailedModelResult_UserPositions+GetUsersDetailedModelResult_Leadership":{"type":"object","properties":{"id":{"format":"int32","description":"Código identificador do gestor imediato","type":"integer"},"name":{"description":"Nome do gestor imediato","type":"string"},"username":{"description":"Username do gestor imediato","type":"string"},"email":{"description":"Endereço de e-mail do gestor imediato","type":"string"}}},"Orquestra.Models.Base.ApiModels.Suport.ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.Error"}}},"Orquestra.Models.Base.ApiModels.Suport.Error":{"type":"object","properties":{"code":{"type":"string"},"key":{"type":"string"},"message":{"type":"string"},"vars":{"type":"array","items":{"type":"string"}},"details":{"type":"array","items":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.Error"}}}}}},"paths":{"/api/2/users/{userid}":{"get":{"tags":["People / Pessoas"],"summary":"Obter pessoa por código (Auth)","description":"[https://kb.stoque.com.br/zeev/apis/all/access/people/consult](https://kb.stoque.com.br/zeev/apis/all/access/people/consult)","operationId":"Users_GetUserById","parameters":[{"schema":{"type":"integer","format":"int32"},"name":"userId","in":"path","description":"Código identificador da pessoa","required":true}],"responses":{"200":{"description":"Sucesso.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Workflow.ApiModels.External._20.Users.GetUsersDetailedModelResult"}}}},"400":{"description":"Solicitação ou dados da solicitação são inválidas","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"401":{"description":"Pessoa não autorizada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"403":{"description":"Pessoa não tem permissão de executar essa operação","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"404":{"description":"O registro não foi encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"429":{"description":"Muitas requisições em um determinado período de tempo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}},"500":{"description":"Ocorreu algum erro interno no servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}},"text/xml":{"schema":{"$ref":"#/components/schemas/Orquestra.Models.Base.ApiModels.Suport.ErrorResponse"}}}}}}}}}
```

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

{% tabs %}
{% tab title="Node.js" %}

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

{% endtab %}
{% endtabs %}

***

### Vídeo de exemplo de uso

{% embed url="<https://youtu.be/Vvzga08uF8c>" %}

## 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](/zeev/apis/all/instances/report.md#como-consultar-solicitacoes-utilizando-as-apis-do-zeev) (na propriedade requester > name) ou em muitos outros.
2. **Autenticação**: Obtenha um [token de autenticação](/zeev/apis/como-utilizar-as-apis-do-zeev/como-gerar-tokens-para-autenticar-nas-apis.md) com permissão de realizar essa operação.
3. **Enviar a Requisição**: Utilize o endpoint [#api-2-users-username](#api-2-users-username "mention") 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](/zeev/apis/como-utilizar-as-apis-do-zeev/como-realizar-filtros-e-manipulacoes-adicionais-nas-apis-com-odata.md) para manipular o resultado da API. Essa API aceita `$select`.

{% hint style="info" %}
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}")].
{% endhint %}

{% openapi src="/files/DYIxvabeLXa2mL6uE2si" path="/api/2/users/{username}" method="get" %}
[ZeevApi's\_new.json](https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2Ff5huLIsAqm88oSjkTavv%2FZeevApi's_new.json?alt=media\&token=aae47f9f-90ca-48d0-b250-fc38fe74e6c0)
{% endopenapi %}

{% tabs %}
{% tab title="Node.js" %}

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/zeev/apis/all/access/people/consult.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.