Get Custom Field Dictionary

The configured custom fields, grouped and in configured order. Unpaginated: consumers need the whole catalog to render columns, labels and filter controls. Archived groups, fields and options are left out — the dictionary describes the current configuration, while values of archived fields are still reported by `/api/v2/custom-fields/values`. Groups without active fields are omitted.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Header Parameters

accept-language?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v2/custom-fields" \  -H "accept-language: ja"

{  "total": 2,  "data": [    {      "groupId": "0191f3c2-2d9a-7b1e-9a3c-6f4b8c1d2e3f",      "name": "kyc",      "label": "KYC",      "sortOrder": 0,      "fields": [        {          "fieldId": "0191f3c2-3f1b-7c4d-8e5f-1a2b3c4d5e6f",          "name": "tax_number",          "label": "Tax number",          "hint": "As printed on your tax certificate",          "type": "text",          "sortOrder": 10,          "isRequired": true,          "validation": {            "required": true,            "minLength": 0,            "maxLength": 0,            "min": "0",            "max": "100",            "decimalScale": 0,            "regex": "string",            "minDate": "1900-01-01",            "maxDate": "2100-01-01",            "minOptions": 0,            "maxOptions": 0,            "mustBeTrue": true          },          "options": [            {              "optionId": "0191f3c2-4a2c-7d5e-9f60-2b3c4d5e6f70",              "value": "gold",              "label": "Gold",              "sortOrder": 0            }          ]        }      ]    }  ]}

{  "error": {    "message": "Unauthorized"  }}

{  "error": {    "message": "Forbidden"  }}

{  "error": {    "message": "Too Many Requests"  }}

{  "error": {    "message": "Service Unavailable"  }}

Get Custom Field Dictionary

Authorization

Header Parameters

Response Body

200application/json

401application/json

403application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`