Logo SOAR

Buscar Organizações Por Nome

Descrição

Retorna organizações com suporte a paginação (12 itens por página por padrão), busca por nome e filtros opcionais de localização (país, estado, cidade). Todos os filtros podem ser combinados. Inclui a contagem de grupos e iniciais de cada grupo vinculado.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/organizations/search?page=1&limit=12&name=soar&country=Brasil

Query Parameters (Opcionais)

Parâmetro Tipo Descrição Padrão
page integer Número da página 1
limit integer Itens por página (máximo: 50) 12
name string Busca por nome da organização -
country string Filtra por país -
state string Filtra por estado -
city string Filtra por cidade -

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Organizations found successfully.",
  "page": 1,
  "limit": 12,
  "total": 15,
  "data": [
    {
      "org_id": "36",
      "org_name": "SOAR Global Initiative",
      "email": "contato@soar.com",
      "description": "Organização focada em desenvolvimento",
      "phone": "",
      "country": "Brasil",
      "state": "SP",
      "city": "São Paulo",
      "address": "",
      "postal_code": "",
      "avatarURL": "",
      "created_at": "2025-04-15 20:06:53",
      "updated_at": "2025-04-15 20:06:53",
      "owner_id": "6",
      "group_count": 3,
      "group_initials": ["SO","AR","GI"]
    }
  ]
}

Erro - 404 (No organizations found)

{
  "success": false,
  "message": "No organizations found."
}

Códigos de Resposta

  • 200 - Organizações encontradas com sucesso
  • 404 - Nenhuma organização encontrada com os filtros aplicados
  • 401 - Token inválido ou expirado