Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → Get Account

AI-generated

Summary

Retrieve details of the current Yext account associated with the configured API credentials.

Inputs

  • Request Options — Configure request-specific options including batching settings (items per batch and interval between batches), SSL certificate validation ignoring, HTTP proxy settings, and request timeout in milliseconds.

Output shape

a single JSON object representing the Yext account details

The output is directly returned from the Yext Admin API's Get Account endpoint and should contain relevant account information. Batching options are available but typically not applicable since the operation retrieves a single account record. Errors or authentication issues may result in failure responses.

Discussion