v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Loyalties

List Loyalty Campaigns

Returns a list of your loyalty campaigns.

get/v1/loyalties

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

pageinteger

Which page of results to return. The lowest value is 1.

expand'category' | 'access_settings_assignments'

Includes an expanded categories object in the response. If the Areas and Stores Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Response

Returns a dictionary with loyalty program objects. The loyalty campaigns are returned sorted by creation date, with the most recent campaigns appearing first.

objectstring

The type of the object represented by JSON. This object stores information about loyalty campaigns in a dictionary.

data_ref'campaigns'

Identifies the name of the attribute that contains the array of loyalty campaign objects.

totalinteger

Total number of loyalty campaign objects.

Example response

{
  "campaigns": [
    {
      "id": "camp_f7fBbQxUuTN7dI7tGOo5XMDA",
      "voucher": {
        "start_date": "2022-09-20T00:00:00.000Z",
        "expiration_date": "2022-09-30T00:00:00.000Z",
        "validity_timeframe": {
          "duration": "PT1H",
          "interval": "P2D"
        },
        "validity_hours": {
          "daily": [
            {
              "start_time": "12:00",
              "expiration_time": "14:00"
            }
          ]
        }
      },
      "validity_timeframe": {
        "duration": "PT1H",
        "interval": "P2D"
      },
      "validity_hours": {
        "daily": [
          {
            "start_time": "12:00",
            "expiration_time": "14:00"
          }
        ]
      },
      "start_date": "2022-09-20T00:00:00.000Z",
      "expiration_date": "2022-09-30T00:00:00.000Z",
      "created_at": "2021-12-01T08:00:50.038Z",
      "updated_at": "2022-09-20T09:18:19.623Z",
      "category_id": "cat_0b688929a2476386a7",
      "categories": [
        {
          "created_at": "2022-07-14T10:45:13.156Z",
          "updated_at": "2022-08-16T10:52:08.094Z"
        }
      ],
      "validation_rules_assignments": {
        "data": [
          {
            "id": "asgm_LnY1g7UNFA9KyDrD",
            "rule_id": "val_3gPNA6SnH4ae",
            "related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol",
            "related_object_type": "campaign",
            "object": "validation_rules_assignment",
            "validation_status": "PARTIALLY_VALID",
            "validation_omitted_rules": [
              "1"
            ]
          }
        ]
      },
      "access_settings_assignments": {
        "data": [
          {
            "id": "arsca_0ef5ee192117ae2416",
            "area_id": "ar_0ea6cd7b781b8f857f",
            "area_store_id": "ars_0ec347e2016bed85f4",
            "created_at": "2024-06-25T19:04:16.260Z"
          }
        ]
      }
    }
  ]
}