Get a list of visible campaigns for the member

Integration

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

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

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-01-01T00:00:00.000Z",
        "endsAt": "2026-01-01T00:00:00.000Z"
      },
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": "text",
          "description": "text"
        }
      },
      "description": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "type": "text",
      "trigger": "text"
    }
  ]
}