Achievement

These endpoints will allow you to easily manage achievements.

Deprecated

Get achievements list

get

Management 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

Query parameters

namestringOptional

activebooleanOptional

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 achievements

application/json

401Error

application/json

403

Forbidden.

application/json

get/api/{storeCode}/achievement

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "achievementId": "00000000-0000-0000-0000-000000000000",
      "name": "text",
      "active": true,
      "createdAt": "2026-07-18T15:23:57.263Z",
      "badgeTypeId": "text"
    }
  ]
}

Deprecated

Add an achievement

post

Management This method allows adding a new achievement to 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

Responses

200

Return created achievement ID.

application/json

achievementIdstring · uuidOptionalExample: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

401Error

application/json

403

Forbidden.

application/json

post/api/{storeCode}/achievement

HTTPcURLJavaScriptPython

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

{
  "achievement": {
    "translations": {
      "en": {},
      "es": {}
    },
    "activity": {
      "operator": "is_after"
    },
    "active": true,
    "rules": [
      {
        "completeRule": {
          "period": {
            "type": {},
            "consecutive": 1
          }
        },
        "aggregation": {
          "rule": "text",
          "type": "text"
        },
        "conditions": [
          {
            "attribute": "text",
            "operator": "expression"
          }
        ],
        "translations": {
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "event": "text",
        "uniqueReferee": true
      }
    ],
    "limit": {
      "value": 1,
      "interval": {
        "type": "calendarHours",
        "value": 1
      }
    }
  }
}

{
  "achievementId": "00000000-0000-0000-0000-000000000000"
}

Deprecated

Get member's achievements 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

achievementIdstringOptional

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 achievements 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}/achievement

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "achievementId": "123e4567-e89b-12d3-a456-426614174000",
      "achievementName": "text",
      "achievementDescription": "text",
      "limitReached": true,
      "memberProgress": {
        "completedCount": 1,
        "rules": [
          {
            "achievementRuleId": "text",
            "periodGoal": 1,
            "currentPeriodValue": 1,
            "consecutivePeriods": 1,
            "completedConsecutivePeriods": 1,
            "periodType": "text",
            "type": "text",
            "trigger": "text",
            "periodValue": 1
          }
        ]
      }
    }
  ]
}

Deprecated

Get achievement’s configuration

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

Store code

achievementstring · uuidRequired

Achievement ID

Responses

200

Achievement details

application/json

achievementIdstring · uuidOptional

activebooleanOptional

badgeTypeIdstring · uuidOptional

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/achievement/{achievement}

HTTPcURLJavaScriptPython

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

{
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "translations": {
    "en": {
      "name": "text",
      "description": "text"
    }
  },
  "active": true,
  "limit": {
    "interval": {
      "type": "text",
      "value": 1
    },
    "value": 1
  },
  "activity": {
    "data": "text",
    "operator": "is_greater"
  },
  "rules": [
    {
      "translations": {
        "en": {
          "name": "text",
          "description": "text"
        }
      },
      "achievementRuleId": "text",
      "completeRule": {
        "periodGoal": "text",
        "period": {
          "type": "text",
          "consecutive": 1,
          "value": 1
        },
        "uniqueAttribute": "text"
      },
      "aggregation": {
        "type": "text",
        "rule": "text"
      },
      "uniqueReferee": true,
      "event": "text",
      "limit": {
        "interval": {
          "type": "text",
          "value": 1
        },
        "value": 1
      }
    }
  ],
  "badgeTypeId": "123e4567-e89b-12d3-a456-426614174000"
}

Deprecated

Update achievement’s configuration

put

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

achievementstring · uuidRequired

Achievement ID

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

put/api/{storeCode}/achievement/{achievement}

HTTPcURLJavaScriptPython

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

{
  "achievement": {
    "translations": {
      "en": {},
      "es": {}
    },
    "activity": {
      "operator": "is_after"
    },
    "active": true,
    "rules": [
      {
        "completeRule": {
          "period": {
            "type": {},
            "consecutive": 1
          }
        },
        "aggregation": {
          "rule": "text",
          "type": "text"
        },
        "conditions": [
          {
            "attribute": "text",
            "operator": "expression"
          }
        ],
        "translations": {
          "en": {
            "name": "text",
            "description": "text"
          }
        },
        "event": "text",
        "uniqueReferee": true
      }
    ],
    "limit": {
      "value": 1,
      "interval": {
        "type": "calendarHours",
        "value": 1
      }
    }
  }
}

No content

Deprecated

Update achievement’s configuration

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

achievementstring · uuidRequired

Achievement ID

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}/achievement/{achievement}

HTTPcURLJavaScriptPython

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

{
  "achievement": {
    "translations": {
      "en": {},
      "es": {}
    },
    "activity": {
      "operator": "is_after"
    },
    "active": true,
    "rules": [
      {
        "achievementRuleId": "text",
        "translations": {
          "en": {}
        }
      }
    ],
    "limit": {
      "value": 1,
      "interval": {
        "type": "calendarHours",
        "value": 1
      }
    }
  }
}

No content

Deprecated

Get member's achievements triggers list

get

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

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

achievementIdstring · uuidOptional

ruleIdstring · uuidOptional

triggerIdstring · uuidOptional

createdAtstring · date-timeOptional

campaignIdstring · uuidOptional

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

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

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

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "achievementId": "123e4567-e89b-12d3-a456-426614174000",
      "achievementName": "text",
      "ruleId": "123e4567-e89b-12d3-a456-426614174000",
      "ruleName": "text",
      "triggerId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-07-18T15:23:57.263Z",
      "campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "campaignName": "text"
    }
  ]
}

Deprecated

Update achievement’s 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

achievementstring · uuidRequired

Achievement 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}/achievement/{achievement}/progress

HTTPcURLJavaScriptPython

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

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

No content