Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Knowledge Manager → Get Locations

AI-generated

Summary

Retrieve a list of Location entities from Yext Knowledge API with support for pagination and optional placeholder resolution.

Inputs

  • Limit — Number of Location results to return. Defaults to 10.
  • Offset — Number of Location results to skip, used for paging. Cannot be used together with pageToken. Defaults to 0.
  • Resolve Placeholders — Boolean flag to determine if location placeholders are resolved to actual values (true) or returned as labels (false). Defaults to false.
  • Page Token — Token from a previous response's nextPageToken to retrieve the next page of results.

Output shape

a JSON object containing a list of Location records potentially paged; includes nextPageToken if more data is available

Pagination supports either Offset or Page Token parameters but not both simultaneously. The response includes Location objects with fields either resolved or as placeholders depending on 'Resolve Placeholders' input.

Discussion