Get a custom field group

Management Returns a single custom field group with its field definitions.

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

entityTypestring · enumRequired

Entity type the custom field is associated with.

Possible values:

groupKeystringRequired

Group key

Responses

200

Custom field group details

application/json

customFieldGroupIdstring · uuidRequired

Unique identifier of the group

groupKeystringRequired

Immutable machine-readable identifier

namestringRequired

Human-readable name of the group

descriptionstring · nullableOptional

Optional description of the group

entityTypestring · enumRequired

Entity type the custom field is associated with.

Possible values:

sortOrderinteger · nullableOptional

Display order position

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last modification timestamp

deletedAtstring · date-time · nullableOptional

Soft-deletion timestamp (null if not deleted)

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/custom-field-groups/{entityType}/{groupKey}

GET /api/{storeCode}/custom-field-groups/{entityType}/{groupKey} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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