List custom field groups
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
Store code
Entity type the custom field is associated with.
Number of page with results, starts from 1
1Example: 1Items on one page
10Example: 25Filter by group UUID
Filter by group name (partial match)
Filter by group key (partial match)
Whether to include soft-deleted groups. Defaults to false.
falseList of custom field groups
Bad request.
Unauthorized
Forbidden.
Not found.
GET /api/{storeCode}/custom-field-groups/{entityType} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"customFieldGroupId": "123e4567-e89b-12d3-a456-426614174000",
"groupKey": "text",
"name": "text",
"description": "text",
"entityType": "member",
"sortOrder": 1,
"definitions": [
{
"customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
"key": "text",
"name": "text",
"description": "text",
"fieldType": "text",
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"required": true,
"active": true,
"sortOrder": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"deletedAt": "2026-01-01T00:00:00.000Z"
}
]
}Last updated
Was this helpful?

