> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/api-reference/custom-field-schema.md).
# Custom Field Schema
These endpoints allow you to easily manage custom field schemas.
## Get list of custom field schemas
> \\ \ \
> Returns a paginated list of custom field schemas with optional search and filters
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Custom Field Schema","description":"These endpoints allow you to easily manage custom field schemas."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}}},"schemas":{"CustomFieldSchemaListResponse":{"required":["items","total"],"properties":{"items":{"description":"List of custom field schemas","type":"array","items":{"$ref":"#/components/schemas/CustomFieldSchemaResponse"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object"},"CustomFieldSchemaResponse":{"required":["customFieldSchemaId","name","type","required","active","createdAt"],"properties":{"customFieldSchemaId":{"description":"Unique identifier of the custom field schema","type":"string","format":"uuid"},"name":{"description":"Name of the custom field","type":"string"},"type":{"description":"Type of the custom field","type":"string","enum":["text"]},"required":{"description":"Whether this field is required","type":"boolean"},"active":{"description":"Whether this field is active","type":"boolean"},"createdAt":{"description":"Creation timestamp","type":"string","format":"date-time"},"description":{"description":"Description of the custom field","type":"string","nullable":true},"groupOfValuesId":{"description":"Group of values ID (only for text type fields)","type":"string","format":"uuid","nullable":true}},"type":"object"},"SearchableTotalResponse":{"required":["all","filtered","estimated"],"properties":{"all":{"type":"integer","deprecated":true},"filtered":{"type":"integer","deprecated":true},"estimated":{"description":"Field estimated is used to show that the results are estimated. It might happen when there are more than 5000 results due to performance optimization.","type":"boolean","deprecated":true}},"type":"object","deprecated":true},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/custom-field-schema":{"get":{"tags":["Custom Field Schema"],"summary":"Get list of custom field schemas","description":"
\nReturns a paginated list of custom field schemas with optional search and filters\n","operationId":"_customFieldSchemaList","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"name","in":"query","description":"Filter by name","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Filter by description","required":false,"schema":{"type":"string"}},{"name":"required","in":"query","description":"Filter by required status","required":false,"schema":{"type":"boolean"}},{"name":"active","in":"query","description":"Filter by active status","required":false,"schema":{"type":"boolean"}},{"name":"type","in":"query","description":"Filter by field type","required":false,"schema":{"type":"string","enum":["text"]}}],"responses":{"200":{"description":"Successful response with list of custom field schemas","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSchemaListResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
## Create a new custom field schema
> \\ \ \
> Creates a new custom field schema for members
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Custom Field Schema","description":"These endpoints allow you to easily manage custom field schemas."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}}},"schemas":{"CreateCustomFieldSchemaRequest":{"required":["name","type","required","active"],"properties":{"name":{"description":"Name of the custom field","type":"string","maxLength":255,"minLength":1},"description":{"description":"Description of the custom field","type":"string","maxLength":255,"nullable":true},"type":{"description":"Type of the custom field","type":"string","enum":["text"]},"required":{"description":"Whether this field is required","type":"boolean"},"active":{"description":"Whether this field is active","type":"boolean"},"groupOfValuesId":{"description":"Group of values ID (only for text type fields)","type":"string","format":"uuid","nullable":true}},"type":"object","additionalProperties":false},"CreateCustomFieldSchemaResponse":{"required":["customFieldSchemaId"],"properties":{"customFieldSchemaId":{"description":"ID of the created custom field schema","type":"string","format":"uuid"}},"type":"object"},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/custom-field-schema":{"post":{"tags":["Custom Field Schema"],"summary":"Create a new custom field schema","description":"
\nCreates a new custom field schema for members\n","operationId":"_customFieldSchemaCreate","parameters":[{"$ref":"#/components/parameters/storeCode"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["memberCustomFieldSchema"],"properties":{"memberCustomFieldSchema":{"$ref":"#/components/schemas/CreateCustomFieldSchemaRequest"}},"type":"object","additionalProperties":false}}}},"responses":{"200":{"description":"Custom field schema created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomFieldSchemaResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
## Get a custom field schema
> \\ \ \
> Returns a single custom field schema by its ID
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Custom Field Schema","description":"These endpoints allow you to easily manage custom field schemas."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}}},"schemas":{"CustomFieldSchemaResponse":{"required":["customFieldSchemaId","name","type","required","active","createdAt"],"properties":{"customFieldSchemaId":{"description":"Unique identifier of the custom field schema","type":"string","format":"uuid"},"name":{"description":"Name of the custom field","type":"string"},"type":{"description":"Type of the custom field","type":"string","enum":["text"]},"required":{"description":"Whether this field is required","type":"boolean"},"active":{"description":"Whether this field is active","type":"boolean"},"createdAt":{"description":"Creation timestamp","type":"string","format":"date-time"},"description":{"description":"Description of the custom field","type":"string","nullable":true},"groupOfValuesId":{"description":"Group of values ID (only for text type fields)","type":"string","format":"uuid","nullable":true}},"type":"object"},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}},"responses":{"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/custom-field-schema/{customFieldSchemaId}":{"get":{"tags":["Custom Field Schema"],"summary":"Get a custom field schema","description":"
\nReturns a single custom field schema by its ID\n","operationId":"_customFieldSchemaGet","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"customFieldSchemaId","in":"path","description":"Custom field schema ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Custom field schema details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSchemaResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
## Update a custom field schema
> \\ \ \
> Updates an existing custom field schema
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Custom Field Schema","description":"These endpoints allow you to easily manage custom field schemas."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","name":"Authorization","in":"header","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}}},"schemas":{"UpdateCustomFieldSchemaRequest":{"required":["name","required","active"],"properties":{"name":{"description":"Name of the custom field","type":"string","maxLength":255,"minLength":1},"description":{"description":"Description of the custom field","type":"string","maxLength":255,"nullable":true},"required":{"description":"Whether this field is required","type":"boolean"},"active":{"description":"Whether this field is active","type":"boolean"},"groupOfValuesId":{"description":"Group of values ID (only for text type fields)","type":"string","format":"uuid","nullable":true}},"type":"object","additionalProperties":false},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["message"],"properties":{"message":{"type":"string"}},"type":"object"}},"responses":{"NoContent":{"description":"Success. No content."},"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/custom-field-schema/{customFieldSchema}":{"put":{"tags":["Custom Field Schema"],"summary":"Update a custom field schema","description":"
\nUpdates an existing custom field schema\n","operationId":"_customFieldSchemaUpdate","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"customFieldSchema","in":"path","description":"Custom field schema ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["memberCustomFieldSchema"],"properties":{"memberCustomFieldSchema":{"$ref":"#/components/schemas/UpdateCustomFieldSchemaRequest"}},"type":"object","additionalProperties":false}}}},"responses":{"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://help.openloyalty.io/api-reference/custom-field-schema.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.