Para que serve?
Serve para consultar os usuários.
Quando usar?
Esse serviço geralmente é utilizado para consultar usuários. Existem diversas aplicações, como:
- Exibir os usuários em campo do tipo lista;
- A partir da listagem, realizar a atualização de dados em outro sistema;
- Realizar consulta de processos por usuários.
Como usar?
Na chamada do serviço retorna todos os usuários da plataforma e é possível restringir a consulta através de diversos filtros, conforme a necessidade.
Para executar o serviço, é necessário que o usuário da chave de API tenha a configuração de permissão de acesso como administrativo no seu cadastro.
O retorno da execução desse serviço serão os dados de identificação do usuário, como código, login, e-mail, nome e idioma.
Esse serviço trabalha de forma paginada. Desta forma, na chamada dele podem ser informadas a página e a quantidade de itens por página, que é limitado a 100 itens. Quando não informada a página, são retornados os itens referente a primeira página. Caso não seja informada a quantidade de itens por página, serão retornados 20 itens por página.
Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.
Links das APIs
| Versões | Link | Release Inicial | Release Final | Status |
|---|---|---|---|---|
| v4 | Documentação Técnica | 5.70 RTM 1.00 | 🟢 | |
| v3 | Documentação Técnica | 5.50 RTM 1.06 | 🟡 |
🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada