Buscar Organizações Por Nome

Descrição

Retorna uma lista com até 10 organizações filtradas por nome. É necessário informar ao menos 2 caracteres no parâmetro de busca.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/organizations/search?name=soar

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 da organização (mínimo 2 caracteres).

Sucesso - 200

{
    "success": true,
    "message": "Organizations found successfully.",
    "data": [{
        "org_id": 1,
        "org_name": "SOAR",
        "created_at": "2025-04-23 09:45:00"
    }]
}

A resposta contém um array de organizações que correspondem ao critério de busca.

Erro - 422 (Nome inválido)

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

Erro - 404 (Nenhuma organização encontrada)

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

Códigos de Resposta

  • 200 - Organizações encontradas
  • 422 - Parâmetro "name" inválido ou ausente
  • 404 - Nenhuma organização encontrada