List notifications

Retrieve paginated list of notifications for the authenticated user. Use the archive query parameter to filter by archive state.

get/api/v1/notifications

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/api/v1/notifications
Auth: bearerAuth (a scheme the document does not define)

Query parameters

pageinteger

Page number (1-indexed)

limitinteger

Items per page (maximum 100)

archive'active' | 'archived' | 'all'

Filter by archive state. 'active' (default) hides archived items; 'archived' shows only archived; 'all' returns both.

Response

Paginated list

successtrue required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "info",
      "title": "Reporte semanal enviado",
      "message": "Se ha enviado tu reporte semanal de Mi Organización",
      "metadata": {
        "schemaVersion": 1,
        "event": "reports.weekly.delivered",
        "source": "weekly-report-sender",
        "orgId": "550e8400-e29b-41d4-a716-446655440000",
        "link": {
          "type": "internal",
          "path": "/orgs/550e8400-e29b-41d4-a716-446655440000/analytics"
        },
        "url": "/orgs/550e8400-e29b-41d4-a716-446655440000/analytics",
        "entity": {
          "type": "organization",
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      },
      "createdAt": "2025-03-10T12:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.