Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → Get Add Request

AI-generated

Summary

Retrieve details of a specific Add Request from the Yext Administrative API.

Inputs

  • Request Options — Optional parameters to configure request behaviour such as batching (items per batch and interval), SSL certificate validation ignoring, HTTP proxy settings, and timeout duration in milliseconds.

Output shape

a single record containing the details of the requested Add Request from the Yext Administrative API

The response shape corresponds to the API's JSON response for an Add Request retrieval. Request options like batching affect how requests are throttled but do not alter the shape of returned data. Errors or invalid requests will typically produce API error responses wrapped accordingly.

Discussion