Get campaigns list

Management This method returns detailed information about all Campaigns created in the system.\n\n If sorting is not chosen, the rows will be returned in an unspecified order. \n To sort a result, use an _orderBy parameter in query.

get

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

Query parameters

typestring · enumOptionalPossible values:

triggerstring · enumOptionalPossible values:

eventstringOptional

campaignIdstring · uuidOptional

Campaign ID

namestringOptional

Campaign name

activebooleanOptional

Active

Example: true

availablebooleanOptional

Available

Example: true

startsAtstring · date-timeOptional

endsAtstring · date-timeOptional

labelsstringOptional

Filter with Campaign custom attributes.

Example: labels=(key;value)

formatstring · html|rawOptional

If set to html, the descriptions will be in HTML format. Omit for raw output.

_pageinteger · min: 1Optional

Number of page with results, starts from 1

Default: 1Example: 1

_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page

Default: 10Example: 25

Responses

200

List of campaigns.

application/json

or

or

or

or

or

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/campaign

GET /api/{storeCode}/campaign HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "description": "text",
      "type": "direct",
      "trigger": "transaction",
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "activity": {
        "startsAt": "2026-01-01T00:00:00.000Z",
        "endsAt": "2026-01-01T00:00:00.000Z"
      },
      "active": true,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "displayOrder": 1,
      "rules": [
        {
          "name": "text",
          "description": "text",
          "conditions": [
            {
              "operator": "text",
              "data": [
                "text"
              ],
              "attribute": "text"
            }
          ],
          "effects": [
            {
              "effect": "text",
              "pointsRule": "text",
              "tierSetId": "123e4567-e89b-12d3-a456-426614174000",
              "tierId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        }
      ],
      "transactionItemsFilters": [
        {
          "code": "text",
          "name": "text",
          "filters": [
            {
              "value": {
                "field": "sku"
              },
              "condition": {
                "operator": "eq",
                "value": "text"
              }
            }
          ]
        }
      ],
      "limits": {
        "points": {
          "interval": {
            "type": "days"
          },
          "value": 1
        },
        "pointsPerMember": {
          "interval": {
            "type": "days"
          },
          "value": 1
        },
        "executionsPerMember": {
          "interval": {
            "type": "days"
          },
          "value": 1
        }
      },
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "translations": [
        {
          "name": "text",
          "description": "text",
          "id": 1,
          "locale": "text"
        }
      ],
      "limitUsages": {
        "points": {
          "currentValue": 1,
          "limitValue": 1,
          "remaining": 1,
          "interval": {
            "type": "calendarHours"
          }
        }
      },
      "visibility": {
        "target": "segment",
        "tiers": [
          "text"
        ],
        "segments": [
          "text"
        ]
      },
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}