API Reference

Listar grupos

Para que serve?

Serve para consultar os grupos.

Quando usar?

Esse serviço geralmente é utilizado para consultar grupos. Existem diversas aplicações, como:

  • Consultar os grupos da plataforma;
  • Consultar o líder dos grupos.

Como usar?

Na chamada do serviço é retornado os grupos da plataforma e é possível restringir a consulta através de diversos filtros, conforme a necessidade e deve ser executado a partir do usuário administrador ou modelista.

O retorno da execução desse serviço são os dados de identificação do grupo, como: código, nome e líder do grupo.

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.

VersõesLinksRelease InicialRelease FinalStatus
v3Documentação Técnica5.60 RTM 1.00🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada