Logo SOAR

Listar Usuários de um Grupo

Descrição

Lista todos os usuários vinculados a um grupo específico com base no ID do grupo fornecido. Suporta paginação, busca por nome/email e filtros por organização.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/group-users/list/{groupId}?page=1&limit=12&search=&org_id=&org_name=

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Parâmetros de Query

Parâmetro Tipo Obrigatório Descrição
page int Não Número da página (padrão: 1)
limit int Não Registros por página (padrão: 12)
search string Não Busca por nome ou email
org_id int Não Filtro por ID da organização
org_name string Não Busca por nome da organização

Resposta de Sucesso - 200

{
    "status": "success",
    "message": "Users retrieved successfully.",
    "page": 1,
    "limit": 12,
    "total": 4,
    "data": [
        {
            "user_id": "4",
            "first_name": "Ricardo",
            "last_name": "Almeida Ferreira",
            "email": "ricardo@email.com",
            "avatarUrl": "https://api.soargi.com/public/images/profile/1746252949_f710b113283be793f0db.jpg",
            "org_id": "36",
            "org_name": "OneFactory",
            "group_id": "44",
            "group_name": "G1 OneFactory"
        },
        {
            "user_id": "3",
            "first_name": "Rebeca",
            "last_name": "Knupp",
            "email": "rebecaknupp@gmail.com",
            "avatarUrl": "https://api.soargi.com/public/images/profile/1746117571_0f2b3a4c5d7e8b9c4a6f.jpg",
            "org_id": "36",
            "org_name": "OneFactory",
            "group_id": "44",
            "group_name": "G1 OneFactory"
        },
        {
            "user_id": "8",
            "first_name": "Antonio",
            "last_name": "Andrade",
            "email": "antonio.andrade@onefactory.com.br",
            "avatarUrl": "https://api.soargi.com/public/images/profile/1746117571_0f2b3a4c5d77895522265.jpg",
            "org_id": "36",
            "org_name": "OneFactory",
            "group_id": "44",
            "group_name": "G1 OneFactory"
        },
        {
            "user_id": "2",
            "first_name": "Sérgio",
            "last_name": "Borges",
            "email": "sergio.borges@onefactory.com.br",
            "avatarUrl": "https://api.soargi.com/public/images/profile/1746117571_47854784c5d7e8b9c4790.jpg",
            "org_id": "36",
            "org_name": "OneFactory",
            "group_id": "44",
            "group_name": "G1 OneFactory"
        }
    ]
}

A resposta inclui informações de paginação (page, limit, total) e os dados dos usuários. Se o grupo não tiver usuários, retornará uma mensagem de sucesso com data vazia.

Erro - 400 (ID de grupo não enviado)

{
    "status": 400,
    "error": 400,
    "messages": {
        "error": "Group ID is required."
    }
}

Erro - 404 (Grupo não encontrado)

{
    "status": 404,
    "error": 404,
    "messages": {
        "error": "Group not found."
    }
}

Erro - 500 (Erro interno do servidor)

{
  "status": 500,
  "error": "Failed to process the request."
}

Códigos de Resposta

  • 200 - Usuários listados com sucesso
  • 422 - ID do grupo não enviado
  • 404 - Grupo não encontrado
  • 500 - Erro inesperado ao processar