Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Domains → List Domain Associations

AI-generated

Summary

List domain associations for a specified domain in the Yext account, optionally filtering by referenced resources and supporting pagination.

Inputs

  • Domain Id (required) — Specify the domain ID to list domain associations from. Use "-" to reference all domains in the account.
  • Referenced Resources — Comma-separated list of associated resources to filter domain associations by.
  • Page Size — Number of results to return per page, capped at the API maximum.
  • Page Token — Token for fetching the next page of results for pagination.

Output shape

a paginated list of domain association objects for the specified domain(s)

Results are paginated according to the 'Page Size' and 'Page Token' parameters. Use the returned pagination token to retrieve subsequent pages if available.

Examples

Example 1: Fetch all domain associations for a specific domain with filtering by referenced resources and handling pagination.

Set the Domain Id to target a specific domain or '-' for all domains. Provide Referenced Resources as a JSON array of resource identifiers to filter results. Use Page Size to control the number of results per page and supply a Page Token when requesting additional pages.

Discussion