Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Optimization Tasks → Get Optimization Tasks

AI-generated

Summary

Retrieve Optimization Tasks from the Yext Knowledge API, optionally filtering by specific Task IDs and Location IDs to narrow down the results.

Inputs

  • Task Ids — Comma-separated list of Optimization Task IDs to include in the response. If omitted, all available Optimization Tasks in the account are returned.
  • Location Ids — Comma-separated list of Location IDs to filter Optimization Tasks by location. If omitted, tasks from all Locations in the account are included.
  • Request Options — Additional request settings including batching parameters (items per batch and batch interval in milliseconds), SSL certificate validation toggle, proxy configuration, and request timeout in milliseconds.

Output shape

a list of Optimization Task objects as returned by the Yext Knowledge API

The operation supports optional batching for handling large input lists to throttle requests. If filtering parameters are omitted, all Optimization Tasks across all Locations in the account are returned. Output structure directly reflects the API response format for Optimization Tasks.

Discussion