Actions20
- Administrative API Actions
- List Available Services
- Create New Location Add Request
- Create Existing Location Add Request
- Create Existing Sub Account Add Request
- Cancel Services
- Cancel Sub Account Services
- Cancel All Sub Account Services
- Create Process Review Add Request
- List Add Requests
- Get Add Request
- List Sub Account Add Requests
- Get Sub Account Add Request
- List Services
- List Sub Account Services
- Create Sub Account
- Resources Apply Request
- Get Resources Apply Request Status
- List Accounts
- Get Account
- Update Account
Administrative API → List Add Requests
AI-generatedSummary
Retrieve a filtered list of add requests submitted to the Yext Administrative API.
Inputs
- Status — Filter add requests by their status (e.g., SUBMITTED, PROCESSING, COMPLETE, CANCELED, REVIEW, FAILED). Defaults to SUBMITTED.
- Submitted After — Return add requests submitted after the given date and time (format: YYYY-MM-DDThh:mm:ss).
- Submitted Before — Return add requests submitted before the given date and time (format: YYYY-MM-DDThh:mm:ss).
- Updated After — Return add requests updated after the given date and time (format: YYYY-MM-DDThh:mm:ss).
- Updated Before — Return add requests updated before the given date and time (format: YYYY-MM-DDThh:mm:ss).
- Sku — Filter add requests by specific SKU.
- Agreement Id — Filter add requests by agreement ID.
- Location Id — Filter add requests by location ID.
- Limit — Maximum number of add requests to retrieve. Defaults to 100.
- Offset — Number of results to skip for pagination. Cannot be used together with pageToken.
Output shape
a JSON object containing a list of add requests matching the applied filters
The output includes pagination support via limit and offset parameters. Additional internal request options like batching, proxy, SSL validation, and timeout can be configured but do not affect output shape.