Campaign

These endpoints will allow you to easily manage campaigns.

Get the campaign’s details

get

Management This method returns detailed information about a specific Campaign.

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Responses

200

Campaign details.

application/json

or

or

or

or

or

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/campaign/{campaign}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "type": "direct",
  "trigger": "transaction",
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "activity": {
    "startsAt": "2026-07-18T16:39:56.253Z",
    "endsAt": "2026-07-18T16:39:56.253Z"
  },
  "active": true,
  "createdAt": "2026-07-18T16:39:56.253Z",
  "displayOrder": 1,
  "rules": [
    {
      "name": "text",
      "description": "text",
      "conditions": [
        {
          "operator": "text",
          "data": [
            "text"
          ],
          "attribute": "text"
        }
      ],
      "effects": [
        {
          "effect": "text",
          "pointsRule": "text"
        }
      ]
    }
  ],
  "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"
    }
  }
}

Update campaign’s configuration

put

Management This method allows changing the information about a specific Campaign. Custom-fields semantics on PUT:

• customFields omitted from the request body → existing custom-field values on the campaign are kept untouched (no-op; no validation runs).

• customFields: null → existing values are kept untouched (treated identically to omitting the field).

• customFields: {} (explicit empty object) → all existing custom-field values on the campaign are cleared. Required-field validation still runs against the empty payload, so this fails with 400 if any active campaign custom-field group contains a required field.

• customFields: { groupKey: { fieldKey: value, ... }, ... } → wholesale entity replace. The campaign's entire custom-field state is deleted first, then only the groups present in the payload are persisted. Consequence: any group NOT listed in the payload is also wiped, even if it had values before. Required-field validation runs against the payload as a whole.

The feature flag CUSTOM_FIELD_CAMPAIGN must be enabled; when disabled the customFields key is silently ignored regardless of value. For granular per-group or per-key updates that preserve other groups, use the bulk patch endpoint (PATCH /api/{storeCode}/custom-fields/campaign/{campaignId}).

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Body

application/json

or

or

or

or

or

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/campaign/{campaign}

HTTPcURLJavaScriptPython

PUT /api/{storeCode}/campaign/{campaign} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1318

{
  "campaign": {
    "triggerStrategy": {
      "type": "birthday",
      "executionSchedule": {
        "dayOfWeek": [
          0
        ],
        "dayOfMonth": [
          1
        ]
      }
    },
    "visibility": {
      "target": "segment",
      "tiers": [
        "text"
      ],
      "segments": [
        "text"
      ]
    },
    "audience": {
      "target": "segment",
      "tiers": [
        "text"
      ],
      "segments": [
        "text"
      ]
    },
    "rules": [
      {
        "name": "text",
        "description": "text",
        "target": "self",
        "effects": [
          {
            "effect": "give_points",
            "pointsRule": null,
            "walletCode": "text",
            "unitsLockRule": {
              "lockStrategy": "expression",
              "expression": "text"
            },
            "unitsExpirationRule": {
              "expirationStrategy": "expression",
              "expression": "text"
            },
            "rewardId": "123e4567-e89b-12d3-a456-426614174000",
            "couponValueRule": "text",
            "customAttributeKey": "text",
            "customAttributeValueRule": "text",
            "badgeSystemCode": "text"
          }
        ],
        "conditions": [
          {
            "attribute": "text",
            "operator": "expression",
            "data": null
          }
        ]
      }
    ],
    "limits": {
      "points": {
        "interval": {
          "type": "days"
        },
        "value": 1
      },
      "pointsPerMember": {
        "interval": {
          "type": "days"
        },
        "value": 1
      },
      "executionsPerMember": {
        "interval": {
          "type": "days"
        },
        "value": 1
      }
    },
    "type": "direct",
    "trigger": "achievement",
    "activity": {
      "startsAt": "2024-09-17 00:00+02:00",
      "endsAt": "2024-09-17 00:00+02:00"
    },
    "displayOrder": 1,
    "active": true,
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      },
      "pl": {
        "name": "text",
        "description": "text"
      }
    },
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

No content

Delete campaign.

delete

Management This method allows you to delete campaign.

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/campaign/{campaign}

HTTPcURLJavaScriptPython

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

No content

Update campaign’s configuration

patch

Management This method allows you to change the order in which your campaigns are displayed and campaign activity.

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

patch/api/{storeCode}/campaign/{campaign}

HTTPcURLJavaScriptPython

PATCH /api/{storeCode}/campaign/{campaign} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "campaign": {
    "displayOrder": 1,
    "active": true
  }
}

No content

Get campaigns list

get

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.

Authorizations

Bearertoken

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

HTTPcURLJavaScriptPython

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-07-18T16:39:56.253Z",
        "endsAt": "2026-07-18T16:39:56.253Z"
      },
      "active": true,
      "createdAt": "2026-07-18T16:39:56.253Z",
      "displayOrder": 1,
      "rules": [
        {
          "name": "text",
          "description": "text",
          "conditions": [
            {
              "operator": "text",
              "data": [
                "text"
              ],
              "attribute": "text"
            }
          ],
          "effects": [
            {
              "effect": "text",
              "pointsRule": "text"
            }
          ]
        }
      ],
      "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"
        }
      }
    }
  ]
}

Add a new campaign

post

Management This method allows creating a new Campaign. Custom-fields semantics on POST:

• customFields omitted, null, or {} → the campaign is created with no custom-field values; required-field validation still runs and the request fails with 400 if any active campaign custom-field group contains a required field.

• customFields: { groupKey: { fieldKey: value, ... }, ... } → the provided values are persisted on the new campaign; required-field validation runs against the payload.

The feature flag CUSTOM_FIELD_CAMPAIGN must be enabled; when disabled the customFields key is silently ignored.

Authorizations

Bearertoken

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

Body

application/json

or

or

or

or

or

Responses

200

Return created campaign ID.

application/json

campaignIdstring · uuidRequired

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/campaign

HTTPcURLJavaScriptPython

POST /api/{storeCode}/campaign HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1507

{
  "campaign": {
    "triggerStrategy": {
      "type": "birthday",
      "executionSchedule": {
        "dayOfWeek": [
          0
        ],
        "dayOfMonth": [
          1
        ]
      }
    },
    "visibility": {
      "target": "segment",
      "tiers": [
        "text"
      ],
      "segments": [
        "text"
      ]
    },
    "audience": {
      "target": "segment",
      "tiers": [
        "text"
      ],
      "segments": [
        "text"
      ]
    },
    "rules": [
      {
        "name": "text",
        "description": "text",
        "target": "self",
        "effects": [
          {
            "effect": "give_points",
            "pointsRule": null,
            "walletCode": "text",
            "unitsLockRule": {
              "lockStrategy": "expression",
              "expression": "text"
            },
            "unitsExpirationRule": {
              "expirationStrategy": "expression",
              "expression": "text"
            },
            "rewardId": "123e4567-e89b-12d3-a456-426614174000",
            "couponValueRule": "text",
            "customAttributeKey": "text",
            "customAttributeValueRule": "text",
            "badgeSystemCode": "text"
          }
        ],
        "conditions": [
          {
            "attribute": "text",
            "operator": "expression",
            "data": null
          }
        ]
      }
    ],
    "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
      }
    },
    "type": "direct",
    "trigger": "transaction",
    "event": "text",
    "activity": {
      "startsAt": "2024-09-17 00:00+02:00",
      "endsAt": "2024-09-17 00:00+02:00"
    },
    "displayOrder": 1,
    "active": true,
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "memberFilter": {
      "strategy": null
    },
    "translations": {
      "en": {
        "name": "text",
        "description": "text"
      },
      "pl": {
        "name": "text",
        "description": "text"
      }
    },
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  }
}

{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000"
}

Get a list of available campaigns for the member.

get

Integration This method returns all active Campaigns for Member. The logged in member can only see their own available campaigns. Endpoint returns all active campaigns, for campaigns that have not reached the limit it adds "limitReached": false, and for campaigns that have reached the limit "limitReached": true. If there is a dynamic effect in the campaign, the endpoint may return that the campaign limit is not reached, although the effect may exceed the limit and points will not be awarded If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

Authorizations

Bearertoken

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Query parameters

typestringOptional

triggerstringOptional

eventstringOptional

campaignIdstringOptional

showAllbooleanOptional

This parameter allows to show all campaign even not active

namestringOptional

Campaign name

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 available member campaigns.

application/json

or

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/member/{member}/campaign

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "active": true,
      "activity": {
        "startsAt": "2024-09-17 00:00+02:00",
        "endsAt": "2024-09-17 00:00+02:00"
      },
      "rules": [
        {
          "conditions": [
            {
              "operator": "text",
              "data": [
                "text"
              ],
              "attribute": "text"
            }
          ],
          "effects": [
            {
              "effect": "text",
              "pointsRule": "text"
            }
          ]
        }
      ],
      "limits": {
        "points": {
          "interval": {
            "type": "days"
          },
          "value": 1
        },
        "pointsPerMember": {
          "interval": {
            "type": "days"
          },
          "value": 1
        },
        "executionsPerMember": {
          "interval": {
            "type": "days"
          },
          "value": 1
        }
      },
      "translations": [
        {
          "name": "text",
          "description": "text",
          "id": 1,
          "locale": "text"
        }
      ],
      "createdAt": "2026-07-18T16:39:56.253Z",
      "memberFilter": {},
      "displayOrder": 1,
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "multiLevel": 1,
      "codeGenerator": {},
      "eventCodeAttribute": "text",
      "name": "text",
      "description": "text",
      "type": "text",
      "trigger": "text",
      "event": "text",
      "achievementId": "123e4567-e89b-12d3-a456-426614174000",
      "limitReached": true,
      "limitUsages": {
        "points": {
          "currentValue": 1,
          "limitValue": 1,
          "remaining": 1,
          "interval": {
            "type": "calendarHours"
          }
        }
      }
    }
  ]
}

Get a list of visible campaigns for the member

get

Integration

Authorizations

Bearertoken

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

memberstring · uuidRequired

Member ID

Query parameters

campaignIdstring · uuidOptional

Campaign ID

namestringOptional

Campaign name

triggerstringOptional

Campaign trigger

startsAtstring · date-timeOptional

Campaign start date

endsAtstring · date-timeOptional

Campaign end date

activebooleanOptional

Campaign active status

_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 visible member campaigns.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

get/api/{storeCode}/member/{member}/campaign/visible

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "activity": {
        "startsAt": "2026-07-18T16:39:56.253Z",
        "endsAt": "2026-07-18T16:39:56.253Z"
      },
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": "text",
          "description": "text"
        }
      },
      "description": "text",
      "createdAt": "2026-07-18T16:39:56.253Z",
      "type": "text",
      "trigger": "text"
    }
  ]
}

Get redemption codes list

get

Management

Authorizations

Bearertoken

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

campaignstringRequired

Query parameters

statusstringOptional

codestringOptional

codeIdstringOptional

usedAtstring · date-timeOptional

createdAtstring · date-timeOptional

_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

Codes

application/json

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/campaign/{campaign}/codes

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "codeId": "text",
      "code": "text",
      "status": "text",
      "usedAt": "2026-07-18T16:39:56.253Z",
      "createdAt": "2026-07-18T16:39:56.253Z",
      "createdBy": "text"
    }
  ]
}

Generate redemption codes

post

Management

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/campaign/{campaign}/codes/generate

HTTPcURLJavaScriptPython

POST /api/{storeCode}/campaign/{campaign}/codes/generate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "generate": {
    "numberOfCodes": 1
  }
}

No content

Simulate campaigns result

post

Integration This method returns detailed information about all Campaigns created in the system.

Authorizations

Bearertoken

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

Body

application/json

or

or

Responses

200Success

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/campaign/simulate

HTTPcURLJavaScriptPython

POST /api/{storeCode}/campaign/simulate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2348

{
  "simulate": {
    "trigger": "transaction",
    "customer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "birthDate": "2012-01-01",
      "address": {
        "street": "text",
        "address1": "text",
        "address2": "text",
        "postal": "text",
        "city": "text",
        "province": "text",
        "country": "text"
      },
      "loyaltyCardNumber": "text",
      "legalConsent": true,
      "marketingConsent": true,
      "dataProcessingConsent": true,
      "gender": "text",
      "registeredDate": "2012-01-01",
      "firstTransactionDate": "2012-01-01",
      "lastTransactionDate": "2012-01-01",
      "levelAchievementDate": "2012-01-01",
      "levelId": "123e4567-e89b-12d3-a456-426614174000",
      "tiers": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "numberOfPurchases": "text",
      "purchaseAmount": "text",
      "averagePurchaseAmount": "text",
      "activePoints": "text",
      "spentPoints": "text",
      "earnedPoints": "text",
      "lockedPoints": "text",
      "blockedPoints": "text",
      "expiredPoints": "text",
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "segments": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "referrer": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "birthDate": "2012-01-01",
      "address": {
        "street": "text",
        "address1": "text",
        "address2": "text",
        "postal": "text",
        "city": "text",
        "province": "text",
        "country": "text"
      },
      "loyaltyCardNumber": "text",
      "legalConsent": true,
      "marketingConsent": true,
      "dataProcessingConsent": true,
      "gender": "text",
      "registeredDate": "2012-01-01",
      "firstTransactionDate": "2012-01-01",
      "lastTransactionDate": "2012-01-01",
      "levelAchievementDate": "2012-01-01",
      "levelId": "123e4567-e89b-12d3-a456-426614174000",
      "tiers": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "numberOfPurchases": "text",
      "purchaseAmount": "text",
      "averagePurchaseAmount": "text",
      "activePoints": "text",
      "spentPoints": "text",
      "earnedPoints": "text",
      "lockedPoints": "text",
      "blockedPoints": "text",
      "expiredPoints": "text",
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "segments": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "transaction": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "documentNumber": "text",
      "linkedDocumentNumber": "text",
      "documentType": "sell",
      "purchasedAt": "2023-03-23 10:00+01:00",
      "purchasePlace": "text",
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "items": [
        {
          "sku": "text",
          "name": "text",
          "qty": "text",
          "grossValue": "text",
          "category": "text",
          "maker": "text",
          "labels": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        }
      ]
    }
  }
}

{
  "effects": [
    {
      "type": "give_points",
      "campaign": {
        "name": "text",
        "description": "text",
        "type": "text",
        "trigger": "text",
        "campaignId": "123e4567-e89b-12d3-a456-426614174000",
        "activity": {
          "startsAt": "2026-07-18T16:39:56.253Z",
          "endsAt": "2026-07-18T16:39:56.253Z"
        },
        "active": true,
        "createdAt": "2026-07-18T16:39:56.253Z",
        "displayOrder": 1,
        "rules": [
          {
            "name": "text",
            "description": "text",
            "conditions": [
              {
                "operator": "text",
                "data": "text",
                "attribute": "text"
              }
            ],
            "effects": [
              {
                "effect": "text",
                "pointsRule": "text",
                "unitsExpirationDateRule": {
                  "expirationStrategy": "text",
                  "expression": "text"
                }
              }
            ]
          }
        ],
        "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",
              "value": 1
            }
          }
        },
        "triggerStrategy": {
          "type": "birthday",
          "executionSchedule": {
            "dayOfWeek": [
              0
            ],
            "dayOfMonth": [
              1
            ]
          }
        }
      },
      "points": 1,
      "wallet": "text",
      "rewardId": "text",
      "expression": "text",
      "badgeSystemCode": "text",
      "target": "self"
    }
  ],
  "evaluationWarnings": [
    {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text"
    }
  ],
  "simulatedMember": {
    "memberId": "123e4567-e89b-12d3-a456-426614174000",
    "wallets": [
      {
        "walletId": "123e4567-e89b-12d3-a456-426614174000",
        "walletType": {
          "code": "text",
          "name": "text",
          "isDefault": true,
          "active": true,
          "unitSingularName": "text",
          "unitPluralName": "text",
          "rewardSpending": true
        },
        "account": {
          "activeUnits": 1
        }
      }
    ]
  }
}

Get campaign leaderboard

get

Integration This method returns the leaderboard for a specific campaign, showing members ranked by their scores.

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Query parameters

typestringOptional

The type of cycle for which the ranking is to be returned.

groupstring · max: 255Optional

Scope the ranking to a single group of a grouped leaderboard. Required for grouped leaderboards — calling the endpoint without group on a grouped leaderboard returns an empty list (items: [], total.all: 0). Ignored for non-grouped leaderboards. Only the EQUAL operator is accepted; operators like [neq] are rejected with HTTP 400. Maximum length: 255.

Example: Warsaw

Responses

200

Campaign leaderboard with member rankings.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/campaign/{campaign}/leaderboard

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "member": {
        "customerId": "90fb7967-34cb-4440-8786-651dd861d874",
        "firstName": "text",
        "lastName": "text",
        "email": "[e-mail]",
        "phone": "501911936",
        "loyaltyCardNumber": "3581"
      },
      "ranking": {
        "score": 123.1,
        "recalculatedAt": "2010-01-01T01:01:01Z",
        "position": 1,
        "changedPositionAt": "2010-01-01T01:01:01Z",
        "progress": {
          "general": 4,
          "recalculated": 0,
          "period": 2
        }
      }
    }
  ],
  "total": {
    "all": 1,
    "filtered": 1,
    "estimated": true
  }
}

List distinct group values for a grouped leaderboard

get

Integration Returns the distinct group values present on the leaderboard's currently running iteration. Use these values to populate the group query parameter of the leaderboard ranking endpoint. Returns an empty list when: - the campaign's leaderboard is not grouped, - no iteration is currently running (the leaderboard hasn't started or just completed),

• the running iteration has no ranking rows yet. Returns 404 when the campaign does not exist for the given store, is not a leaderboard campaign, or belongs to a different tenant.

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

Query parameters

name[startsWith]stringOptional

Case-insensitive, left-anchored prefix filter on the group value (matches value%). Only the startsWith operator is supported — a disallowed operator such as name[like] returns HTTP 400. The short form name=<prefix> is treated identically to name[startsWith]=<prefix>.

Example: war

_pageinteger · min: 1Optional

1-based page index.

Default: 1

_itemsOnPageinteger · min: 1Optional

Page size.

Default: 10

_orderBy[groupValue]string · enumOptional

Sort direction for the groupValue column. Only asc and desc are accepted.

Default: ascPossible values:

Responses

200

Distinct group values for the running iteration.

application/json

itemsstring[]OptionalExample: Warsaw

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/campaign/{campaign}/leaderboard/group

HTTPcURLJavaScriptPython

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

{
  "items": [
    "Warsaw"
  ],
  "total": {
    "all": 4,
    "filtered": 1,
    "estimated": false
  }
}

Get member's ranking in a specific campaign

get

Integration This method returns detailed information about a member's ranking in a specific campaign, including surrounding members.

Authorizations

Bearertoken

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

campaignstring · uuidRequired

Campaign ID

memberstring · uuidRequired

Member identifier (UUID)

Query parameters

typestringOptional

The type of cycle for which the ranking is to be returned.

Responses

200

Member's ranking details with surrounding members.

application/json

groupValuestringOptional

Group label the member is ranked under for grouped leaderboards (e.g. the city or custom attribute value). Empty string for non-grouped leaderboards. Members with no resolvable group value on a grouped leaderboard are not found here (404).

Example: Warsaw

scorenumber · floatOptional

Member's score in the campaign

Example: 123.1

recalculatedAtstring · date-timeOptional

When the position was last recalculated

Example: 2010-01-01T01:01:01Z

positionintegerOptional

Current position in the leaderboard

Example: 1

changedPositionAtstring · date-timeOptional

When the position changed or initial date

Example: 2010-01-01T01:01:01Z

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/campaign/{campaign}/leaderboard/member/{member}

HTTPcURLJavaScriptPython

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

{
  "groupValue": "Warsaw",
  "score": 123.1,
  "recalculatedAt": "2010-01-01T01:01:01Z",
  "position": 1,
  "changedPositionAt": "2010-01-01T01:01:01Z",
  "progress": {
    "general": 4,
    "recalculated": 0,
    "period": 2
  },
  "surrounding": {
    "higher": [
      {
        "member": {
          "customerId": "90fb7967-34cb-4440-8786-651dd861d874",
          "firstName": "text",
          "lastName": "text",
          "email": "[e-mail]",
          "phone": "501911936",
          "loyaltyCardNumber": "3581"
        },
        "ranking": {
          "score": 123.1,
          "recalculatedAt": "2010-01-01T01:01:01Z",
          "position": 1,
          "changedPositionAt": "2010-01-01T01:01:01Z",
          "progress": {
            "general": 4,
            "recalculated": 0,
            "period": 2
          }
        }
      }
    ],
    "lower": [
      {
        "member": {
          "customerId": "90fb7967-34cb-4440-8786-651dd861d874",
          "firstName": "text",
          "lastName": "text",
          "email": "[e-mail]",
          "phone": "501911936",
          "loyaltyCardNumber": "3581"
        },
        "ranking": {
          "score": 123.1,
          "recalculatedAt": "2010-01-01T01:01:01Z",
          "position": 1,
          "changedPositionAt": "2010-01-01T01:01:01Z",
          "progress": {
            "general": 4,
            "recalculated": 0,
            "period": 2
          }
        }
      }
    ]
  }
}

Get member's challenge status

get

Integration

Authorizations

Bearertoken

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Query parameters

namestringOptional

createdAtstring · date-timeOptional

campaignIdstringOptional

completionCountintegerOptional

_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 active challenge progress for member

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/{member}/challenge

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "text",
      "campaignDescription": "text",
      "limitReached": true,
      "memberProgress": {
        "completedCount": 1,
        "milestones": [
          {
            "milestoneId": "text",
            "periodGoal": 1,
            "currentPeriodValue": 1,
            "consecutivePeriods": 1,
            "completedConsecutivePeriods": 1,
            "periodType": "text",
            "type": "text",
            "trigger": "text",
            "periodValue": 1
          }
        ]
      }
    }
  ]
}

Get member's challenge triggers list

get

Integration This endpoint provides a log of all events that contributed to the progress of a member's challenge.

If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

Authorizations

Bearertoken

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Query parameters

campaignIdstring · uuidOptional

milestoneIdstring · uuidOptional

triggerIdstring · uuidOptional

createdAtstring · date-timeOptional

_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 challenge triggers for a member

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/challenge/trigger/member/{member}

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "milestoneId": "123e4567-e89b-12d3-a456-426614174000",
      "milestoneName": "text",
      "triggerId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-07-18T16:39:56.253Z",
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "text"
    }
  ]
}

Update challenge progress for member

patch

Management

Authorizations

Bearertoken

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

challengestring · uuidRequired

Challenge campaign ID

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

patch/api/{storeCode}/member/{member}/challenge/{challenge}/progress

HTTPcURLJavaScriptPython

PATCH /api/{storeCode}/member/{member}/challenge/{challenge}/progress HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "memberProgress": {
    "completedCount": 1,
    "milestones": [
      {
        "milestoneId": "123e4567-e89b-12d3-a456-426614174000",
        "currentPeriodValue": 1,
        "completedConsecutivePeriods": 1
      }
    ]
  }
}

No content