Yext Admin API icon

Yext Admin API

Interact with Yext Admin API

Administrative API → List Sub Account Services

AI-generated

Summary

List sub account services filtered by optional parameters such as SKU, sub account ID, status, agreement ID, with pagination support using limit and offset.

Inputs

  • Sku — Filters services by the specified SKU.
  • Sub Account Id — Filters services to a specific sub account by its ID.
  • Status — Filters services by status; can be ACTIVE (default), STOPPED, or ALL.
  • Agreement Id — Filters services associated with a specific agreement ID.
  • Limit — Specifies the maximum number of services to return. Defaults to 100.
  • Offset — Specifies how many results to skip for pagination. Cannot be used with pageToken.

Output shape

a JSON array of sub account service objects matching the filter criteria

Results can be paginated using the limit and offset query parameters. By default, only ACTIVE services are returned unless status is set to ALL or STOPPED.

Discussion