Actions176
- Health Check Actions
- Knowledge Manager Actions
- List Entities
- Create Entity
- Get Entity
- Update Entity
- Delete Entity
- List Language Profiles
- List All Language Profiles
- Get Language Profile
- Upsert Language Profile
- Delete Language Profile
- Get Locations
- Create Location
- Search Locations
- Get Location
- Update Location
- Get Location Folders
- Get Menus
- Create Menu
- Get Menu
- Update Menu
- Delete Menu List
- Get Bios
- Create Bio
- Get Bio
- Update Bio
- Delete Bio List
- Get Products
- Create Product
- Get Product
- Update Product
- Delete Product List
- Get Events
- Create Event
- Get Event
- Update Event
- Delete Event List
- Get Business Categories
- Get Google Keywords
- Get Custom Fields
- Create Custom Field
- Get Custom Field
- Update Custom Field
- Delete Custom Field
- Get Language Profiles
- Get Location Language Profile
- Upsert Location Language Profile
- Delete Location Language Profile
- List Assets
- Create Asset
- Get Asset
- Update Asset
- Delete Asset
- Upsert Suggestion
- List Suggestions
- Cancel Suggestion
- Get Suggestion
- Comment Suggestion
- Update Suggestion
- Listings Actions
- List Publishers
- List Listings
- Opt In Listings
- Opt Out Listings
- Confirm Sync Listings
- Force Sync Listings
- List Publisher Suggestions
- Get Publisher Suggestion
- Update Publisher Suggestion
- List Duplicates
- Create Duplicate
- Delete Duplicate
- Suppress Duplicate
- List Methods
- List Statuses
- Initiate Verification
- Complete Verification
- List Admins
- Invite Admins
- List Entity Listings
- Delete Listings
- List Questions
- Get Question
- Create Answer
- Update Answer
- Delete Answer
- Analytics Actions
- Logs API Actions
- Reviews Actions
- Social Actions
- Account Settings Actions
- Optimization Tasks Actions
- Connectors Actions
- Configuration Actions
- Licenses Actions
- Computations Actions
- Domains Actions
Reviews → List Review Invitations
AI-generatedSummary
List review invitations for a specified account with optional filtering and pagination support.
Inputs
- Account Id (required) — The unique identifier of the Yext account to list review invitations from.
- V (required) — API version date in YYYYMMDD format, required for the request.
- Limit — Maximum number of review invitations to return (default is 10).
- Offset — Number of review invitations to skip for paging (cannot be used with pageToken).
- Page Token — Token string to retrieve the next page of results when pagination is used (effective with API version 20240626 or later).
- Location Ids — List of location IDs to filter invitations returned (only invitations for these locations).
- Folder Ids — List of folder IDs to restrict invitations to locations in those folders and subfolders.
- Location Labels — List of labels to filter invitations by locations that have any of the provided labels.
- Template Ids — List of template IDs to limit invitations to those using the specified templates.
- Status — Filter invitations by their status: ACCEPTED, REJECTED, or PENDING (default is ACCEPTED).
- Type — Filter invitations by type: EMAIL or SMS (default is EMAIL).
Output shape
a JSON object containing a list of review invitations matching the criteria, potentially paginated with nextPageToken for fetching subsequent pages.
Pagination is supported via 'offset' for API versions before 20240626 and 'pageToken' for version 20240626 or later. The 'limit' parameter controls page size. Filtering available on multiple fields allows granular retrieval of invitations.