Buscar Grupos Por Nome

Descrição

Retorna uma lista com até 10 grupos filtrados por nome. É necessário informar ao menos 2 caracteres no parâmetro de busca.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/groups/search?name=liderança

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Parâmetros de Consulta (Query String)

Parâmetro Tipo Obrigatório Descrição
name string Sim Nome ou parte do nome do grupo (mínimo 2 caracteres).

Sucesso - 200

{
  "success": true,
  "message": "Groups filtered successfully.",
  "data": [
    {
      "group_id": 1,
      "group_name": "Liderança Técnica",
      "org_id": 1,
      "created_at": "2025-04-23 10:30:00"
    },
    {
      "group_id": "1",
      "group_name": "G1 OneFactory",
      "org_id": "2",
      "created_at": "2025-04-16 22:08:28"
    }
  ]
}

Erro - 400 (Nome inválido)

{
    "status": 400,
    "error": 400,
    "messages": {
        "error": "Please provide at least 2 characters to search."
    }
}

Erro - 404 (Nenhum grupo encontrado)

{
    "status": 404,
    "error": 404,
    "messages": {
        "error": "No groups found with the provided name."
    }
}

Códigos de Resposta

  • 200 - Grupos encontrados
  • 400 - Parâmetro "name" inválido ou ausente
  • 404 - Nenhum grupo encontrado