Logo SOAR

Listar Todos os Eventos

Descrição

Retorna uma lista paginada de eventos cadastrados no sistema, ordenados por status (ativos primeiro), data de início e título. Suporta filtros por título, 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?page=1&limit=12&title=&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
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.
title string Não Busca por título do evento.
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 retrieved successfully.",
  "page": 1,
  "limit": 12,
  "total": 35,
  "data": [
    {
        "event_id": "1",
        "title": "SOAR Orlando 06-2025",
        "description": "Evento de Boas-Vindas",
        "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"
    },
    {
        "event_id": "1",
        "title": "Evento do Ricardo",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas sit amet dolor turpis. Cras vitae dictum sapien. Donec egestas sapien libero, a gravida lectus dignissim in. Mauris lacus ligula, tincidunt non tellus et, tristique fermentum dolor. Donec non imperdiet lacus, nec sagittis metus. Nullam tincidunt sodales ex vel venenatis. Maecenas bibendum, odio eget dapibus vestibulum, magna ex tempor leo, vel egestas odio lacus ut sem. Donec finibus nisi et leo blandit sodales. Donec quis lobortis nulla. Duis vehicula semper turpis ut porttitor. Sed vel tristique felis. Curabitur nec finibus elit.\n\nMauris ligula risus, euismod et tincidunt a, fringilla faucibus arcu. Nulla sodales turpis vel pharetra lobortis. Etiam sed eleifend quam. Nulla finibus libero at mi ultricies tristique. Duis facilisis sed ex ac posuere. Aenean dictum augue nec posuere dignissim. In et nulla vel lacus volutpat congue. Etiam vehicula suscipit commodo. Suspendisse porta diam nec posuere accumsan. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae;\n\nIn sed quam a nisl egestas malesuada vitae ullamcorper nisi. Fusce pretium ipsum libero, et efficitur dolor molestie et. Aenean pellentesque sagittis enim, non bibendum quam lacinia in. Sed ultrices ullamcorper risus. Cras non pellentesque nibh. Vestibulum porttitor suscipit velit, vel scelerisque augue dictum sed. Fusce id tristique nisi. Phasellus at pretium libero, non elementum sapien. Praesent in ligula sit amet lorem lobortis rhoncus.",
        "start_date": "2025-04-19",
        "end_date": "2025-04-19",
        "start_time": "06:51:00",
        "end_time": "10:48:00",
        "country": "BR",
        "state": "Distrito Federal (DF)",
        "address": "",
        "postal_code": "",
        "timezone": "",
        "cover_image": "http://localhost:8080/public/images/events/1745986904_4d298e63abb9a492e76c.jpg",
        "otp": "398597",
        "otp_expiration": "2025-04-19 23:59:59",
        "status": "expired",
        "created_by": "Ricardo",
        "picture": "https://api.soargi.com/public/images/profile/people-5.jpg",
        "created_at": "2025-04-19 06:48:41",
        "updated_at": "2025-04-30 04:21:44"
    }

  ]
}

Erro - 401 (Token inválido)

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

Códigos de Resposta

  • 200 - Lista de eventos retornada com sucesso
  • 401 - Token inválido ou expirado

Controle de Acesso por Role

  • Admin/Super Admin: Ve todos os eventos do sistema
  • Demais usuários: Veem apenas eventos que criaram

Observações

  • É necessário estar autenticado para acessar este endpoint.
  • 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 podem ser combinados.
  • Os eventos são ordenados por status (ativos primeiro), depois por data de início e título.
  • O status dos eventos expirados é atualizado automaticamente ao acessar este endpoint.
  • O campo otp é gerado automaticamente ao criar o evento.
  • Datas devem estar no formato YYYY-MM-DD (ex: 2025-06-06).