This endpoint returns metadata about all custom fields configured for your project. Use this information to understand available fields before updating article settings.
The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
Success
This response shows all custom field definitions available for the project. Use the field names and metadata to construct update requests.
{
"data": [
{
"field_id": "field-definition-id-1",
"name": "Country",
"type": 0,
"placeholder": "Enter country name",
"help_text": "The country where this article applies",
"max_length": 100
},
{
"field_id": "field-definition-id-2",
"name": "Priority",
"type": 6,
"placeholder": "Enter priority",
"help_text": "Priority level (1=lowest, 10=highest)"
},
{
"field_id": "field-definition-id-3",
"name": "Status",
"type": 2,
"placeholder": "Select status",
"help_text": "Current article status",
"options": [
{
"id": "option-id-active",
"label": "Active"
},
{
"id": "option-id-inactive",
"label": "Inactive"
}
]
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Response for getting custom field definitions
List of custom field definitions for the project
Response model for custom field definition metadata
The unique identifier for the custom field definition (use this when updating values)
The display name of the custom field
The type of the custom field. 0 = Text, 1 = TextArea, 2 = Dropdown, 3 = MultiSelectDropdown, 4 = Date, 5 = Boolean, 6 = Number
Placeholder text for the field
Help text describing the field
Available options for Dropdown and MultiSelectDropdown fields
Option definition for dropdown fields
The option ID (use this value when updating)
The display label for the option
Maximum length for text fields
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
This error occurs when the project ID is invalid or custom fields feature is not enabled.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Custom fields feature is not enabled for this project",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.