Yext Admin APIInstall

Summary

Retrieve a filtered list of sub account add requests from the Yext Administrative API based on status, submission and update timestamps, SKU, agreement ID, and sub account ID, with pagination support.

Inputs

• Status — Filter requests by their status. Options include SUBMITTED, PROCESSING, COMPLETE, CANCELED, and FAILED. Default is SUBMITTED.
• Submitted After — Filter requests submitted after this date and time (YYYY-MM-DDThh:mm:ss format).
• Submitted Before — Filter requests submitted before this date and time (YYYY-MM-DDThh:mm:ss format).
• Updated After — Filter requests updated after this date and time (YYYY-MM-DDThh:mm:ss format).
• Updated Before — Filter requests updated before this date and time (YYYY-MM-DDThh:mm:ss format).
• Sku — Filter requests by SKU identifier.
• Agreement Id — Filter requests by agreement ID number.
• Sub Account Id — Filter requests by sub account ID.
• Limit — Maximum number of results to return. Default is 100.
• Offset — Number of results to skip for pagination purposes. Cannot be used together with pageToken. Default is 0.

Output shape

a JSON object containing a list of sub account add requests matching the specified filters

The response includes pagination support via limit and offset parameters to control result subset. All filtering parameters are optional; defaults result in listing requests with status SUBMITTED, up to 100 results starting at offset 0.

Examples

Example 1: List all SUBMITTED sub account add requests submitted after January 1, 2023

Set Status to SUBMITTED and Submitted After to '2023-01-01T00:00:00' with default pagination.