Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Domains → List Domains

AI-generated

Summary

List domains managed by the Yext account, optionally filtering by hostname and including deleted domains.

Inputs

  • Hostname — Filter the list to domains matching specified hostnames; if omitted, returns domains for all hostnames.
  • Show Deleted — Boolean flag to include domains that have been deleted in the results.
  • Page Size — Number of domain records to return per page, capped at the API maximum limit.
  • Page Token — Token for retrieving a specific page of results; leave empty to start from the first page.
  • View — Choose between BASIC (faster, less SSL detail) or FULL (detailed, includes SSL info) responses.

Output shape

a paginated list of domain objects matching the filter criteria, with optional inclusion of deleted domains

Results include pagination via page tokens; the exact domain object fields depend on the selected View. Pagination tokens in responses can be used as input for subsequent requests to retrieve additional pages.

Discussion