Logo SOAR

Buscar Eventos Por Título

Descrição

Retorna uma lista paginada de eventos filtrados pelo título. É necessário informar ao menos 2 caracteres no parâmetro de busca. Suporta filtros adicionais por status, localização (país, estado, cidade) e período de datas. Retorna 12 registros por página por padrão. Os dados são filtrados automaticamente baseado no role do usuário autenticado.

Verbo

GET

URL Base

https://api.soargi.com

Endpoint

/events/search?page=1&limit=12&title=Congresso&status=active&country=&state=&city=&start_date=&end_date=

Cabeçalhos

Parâmetro Valor
Authorization Bearer Token

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
title string Sim Título ou parte do título do evento (mínimo 2 caracteres).
page integer Não Número da página. Padrão: 1.
limit integer Não Quantidade de registros por página. Padrão: 12.
status string Não Filtrar por status do evento. Valores: "active", "expired".
country string Não Filtrar por país do evento.
state string Não Filtrar por estado do evento.
city string Não Filtrar por cidade do evento.
start_date date Não Filtrar eventos a partir desta data (formato: YYYY-MM-DD).
end_date date Não Filtrar eventos até esta data (formato: YYYY-MM-DD).

Sucesso - 200

{
  "success": true,
  "message": "Events filtered successfully.",
  "page": 1,
  "limit": 12,
  "total": 8,
  "data": [
    {
      "event_id": 12,
      "title": "Congresso Nacional de Saúde",
      "description": "Evento privado sobre o Congresso Nacional de Saúde.",
      "start_date": "2025-06-06",
      "end_date": "2025-06-07",
      "start_time": "09:00:00",
      "end_time": "18:00:00",
      "country": "US",
      "state": "Florida (FL)",
      "address": "Lakehurst",
      "postal_code": "0000000",
      "timezone": "America/New_York",
      "cover_image": "https://api.soargi.com/public/images/events/1745714592_62ff3a0df888e555ceea.png",
      "otp": "915511",
      "otp_expiration": "2025-06-07 23:59:59",
      "status": "active",
      "created_by": "João",
      "picture": null,
      "created_at": "2025-04-25 14:52:17",
      "updated_at": "2025-04-27 00:43:12"
    }
  ]
}

Erro - 401 (Token inválido)

{
  "status": 401,
  "error": "Token is invalid or has expired"
}

Erro - 422 (Título inválido)

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

Códigos de Resposta

  • 200 - Eventos encontrados com sucesso
  • 401 - Token inválido ou expirado
  • 422 - Parâmetro "title" inválido ou ausente

Controle de Acesso por Role

  • Admin/Super Admin: Busca em todos os eventos do sistema
  • Demais usuários: Buscam apenas em eventos que criaram

Observações

  • É necessário estar autenticado para acessar este endpoint.
  • O parâmetro title é obrigatório e deve ter no mínimo 2 caracteres.
  • A busca é realizada no campo title.
  • Os dados são filtrados automaticamente baseado no role do usuário.
  • A paginação padrão retorna 12 registros por página.
  • Todos os filtros (title, status, country, state, city, start_date, end_date) podem ser combinados com a paginação.
  • Os resultados são ordenados por data de início.
  • Datas devem estar no formato YYYY-MM-DD (ex: 2025-06-06).