Get the campaign’s details

Management This method returns detailed information about a specific Campaign.

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

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}

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-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"
    }
  }
}