Skip to documentation
SparkGlimSparkGlim Developer
Search all documentation

Try a topic in your language or an exact API path.

    API reference

    Public campaign discovery

    Searches the strict public campaign index with product, country, lifecycle, location and date filters, returning exact pagination and disclosure-gated facts.

    GEThttps://api.sparkglim.net/api/public/homepage/discovery

    Access model

    Access model
    Public access with validation
    Documented availability
    Implemented in source

    Availability is verified from source, not a live production guarantee.

    Return only the records permitted by account, campaign and visibility settings.

    Parameters

    NameTypeValidation
    qOptional

    Search text matched against public campaign title, description, organizer and applicable location or beneficiary fields.

    stringValidation: <=100.
    countryOptional

    Filter by the campaign’s configured country; this does not enable payment methods or convert currency.

    stringValidation: ISO2.
    locationOptional

    Public campaign location or discovery location filter; separate from the financial selling country.

    stringValidation: <=100.
    typeOptional

    Supported resource kind, reaction kind or discovery campaign filter specified by this endpoint.

    enumValidation: all | ticketing | voting | donation.
    statusOptional

    Requested supported lifecycle state; account and campaign approval rules still control publication and access.

    enumValidation: all | active | upcoming | ended | postponed.
    sortOptional

    Selects the server’s supported featured, latest or closing-date ordering.

    enumValidation: featured | latest | ending.
    dateOptional

    Restricts discovery to the documented event/campaign date window in the existing server filter.

    enumValidation: all | today | tomorrow | weekend | month.
    pageOptional

    Requested result page within the endpoint’s documented numbering; retain server pagination metadata.

    integerValidation: 1–1000000.
    limitOptional

    Maximum records returned in this page; the endpoint’s fixed bound applies.

    integerValidation: 1–24 default12.

    Request

    Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

    GET /api/public/homepage/discovery
    http
    GET /api/public/homepage/discovery HTTP/1.1
    Host: api.sparkglim.net

    Response

    Success response · HTTP 200
    json
    {
      "success": true,
      "data": {
        "entries": [],
        "countries": [],
        "locations": [],
        "pagination": {
          "page": 1,
          "limit": 12,
          "total": 0,
          "pages": 0,
          "hasMore": false
        },
        "available": true
      }
    }
    Error response · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

    Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

    Limits & retries

    Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

    Source compatibility

    Authorized operations require account-specific testing.

    • server/src/api/routes/public-homepage.ts