Column Custom Fields

  • Published on Jan 6, 2026
  • 1 minute(s) read
Prev Next
Get
/api/v1/Catalog/custom-fields/column

Returns a list of column custom fields

Security
API Key: x-val-api-token
Header parameter namex-val-api-token

API key needed to access endpoints. Each Validatar user can manage their own set of API keys.

Responses
200

OK

Expand All
object
sections
Array of object (Configuration.Api.Models.v1.SectionSummary) | null

List of summaries for all active custom field sections

object
sectionName
string | null

The name of the section

sectionId
integer (int32)

The ID of the section

fields
Array of object (Configuration.Api.Models.v1.FieldSummary) | null

List of summaries for the section's fields

object
fieldId
integer (int32)

The ID of the field

fieldName
string | null

The name of the field

fieldDataType
string
Valid values[ "ShortText", "Date", "Paragraph", "UserGroupList", "Dropdown", "TagList" ]
options
Array of object (Configuration.Api.Models.v1.FieldOptionSummary) | null

List of summaries of the options of the field

object
optionName
string | null

The name of the option

optionId
integer (int32)

The ID of the option