Listar todos os grupos de usuários

GET https://.account-name.krzlabs.io/api/v1/users-groups

Realiza a busca de todos os grupos de usuários.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
source_id	string	Identificador único do grupo de usuários.	required	false
name	string	Nome do grupo de usuários.	required	false
description	string	Descrição do grupo de usuários.	not required	false
users	array(UserGroupUserType)	Lista de usuários que pertencem ao grupo Exemplo de estrutura: id - string (Identificador único do usuário) name - string (Nome do usuário) email - string (Email do usuário)	not required	false

Exemplo de resposta em JSON

{
  "source_id": "SRC001",
  "name": "Equipe de Vendas",
  "description": "Grupo responsável pelas vendas de produtos e serviços",
  "has_full_product_access": true,
  "users": [
    {
      "id": "64dfae5b2c1f8a7b9d123456",
      "name": "Maria Silva",
      "roles": ["admin", "vendedor"]
    },
    {
      "id": "64dfae5b2c1f8a7b9d654321",
      "name": "João Souza",
      "roles": ["vendedor"]
    }
  ]
}

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema