Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Knowledge Manager → Get Custom Field

AI-generated

Summary

Retrieve details for a single Custom Field from the Yext Knowledge API by specifying its identifier and the associated entity type.

Inputs

  • requestOptions — Optional settings to configure the request behavior such as batching (items per batch and batch interval), ignoring SSL certificate issues, HTTP proxy, and request timeout in milliseconds.

Output shape

a single JSON object representing the Custom Field resource as returned by the Yext Knowledge API

The output returns the Custom Field details in JSON format. Request options affect how the node handles multiple inputs and network communication but do not change the shape of the returned data.

Examples

Example 1: Fetch a specific Custom Field

Configure the node with the Custom Field ID and entity type; optionally adjust requestOptions for batching or network settings; execute to get the Custom Field details.

Discussion