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 Services
AI-generatedSummary
Retrieve a list of services from the Yext Administrative API, optionally filtered by parameters such as SKU, location, agreement, and status, with support for pagination.
Inputs
- Sku — Filter services by SKU.
- Location Id — Filter services by a specific location ID.
- Location Account Id — (Portal Mode only) Filter services by the account ID of the location receiving the service.
- Status — Filter services by their status; defaults to 'ACTIVE'. Options include 'ACTIVE', 'STOPPED', or 'ALL'.
- Agreement Id — Filter services associated with a specific agreement ID.
- Limit — Maximum number of service records to return; default is 100.
- Offset — Number of results to skip for pagination; cannot be used with pageToken.
Output shape
a list of service objects
The output is paginated according to the 'limit' and 'offset' parameters. The returned list includes services matching the specified filters. No implicit error envelope is described in the documentation.