SMsmile
Earning Rules

List earning rules

Retrieves a list of enabled earning rules.

get/earning_rules

Request

  • Base URL
    https://api.smile.io/v1
  • URL
    https://api.smile.io/v1/earning_rules
  • Auth
    HTTP bearer

Query parameters

limitinteger

The maximum number of earning rules to retrieve.

cursorstring

Cursor for the page of earning rules to retrieve.

Response

Example response

{
  "earning_rules": [
    {
      "id": 739246764,
      "name": "Place an order",
      "image_url": "https://platform.smile.io/images/earning/order-online.svg",
      "restricted_to_vip_tier_ids": [
        426715799
      ],
      "reward": {
        "type": "points"
      },
      "reward_value": {
        "type": "variable",
        "variable": {
          "value": 5,
          "per_amount": 1
        },
        "fixed": {
          "value": 100
        }
      },
      "earning_limit": {
        "max": 5,
        "type": "rolling",
        "rolling": {
          "unit": "day",
          "unit_count": 30
        }
      }
    }
  ],
  "metadata": {
    "next_cursor": "aWQ6MixkaXJlY3Rpb246bmV4dA=="
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.