# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for App Store Connect Apps API version: 1.0.0 extends: openapi/ios-apps-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-10-01' generator: build-phrasing.py label: Generated by API Evangelist operations: 86 - target: $.paths['/v1/apps'].get update: x-apievangelist-phrasing: intent: List my apps effect: read questions: - How do I see every app in my App Store Connect account? - Can I find an app by its bundle ID or SKU? - Which of my apps currently have a review submission waiting? instructions: - text: List all my apps. - text: Find the app with bundle ID {bundle_id}. slots: bundle_id: query.filter[bundleId] - text: Show my apps named {name}, sorted by {sort}. slots: name: query.filter[name] sort: query.sort method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}'].get update: x-apievangelist-phrasing: intent: Get an app's details effect: read questions: - What details can I pull for a single app, like its bundle ID and primary locale? - Can I look up one app by its App Store Connect ID? instructions: - text: Get the details of app {app}. slots: app: path.id - text: Show me the record for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}'].patch update: x-apievangelist-phrasing: intent: Update an app's settings effect: write questions: - Can I change an app's primary locale or content rights declaration? - What app-level settings can be edited after the app is created? instructions: - text: 'Update app {app} with these settings: {changes}.' slots: app: path.id changes: requestBody.data - text: Change the app-level attributes of app {app} to {changes}. slots: app: path.id changes: requestBody.data method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/accessibilityDeclarations'].get update: x-apievangelist-phrasing: intent: List accessibility declaration IDs for an app effect: read questions: - Can I get only the IDs of the accessibility declarations linked to an app? - Which accessibility declaration identifiers belong to my app? instructions: - text: Get the accessibility declaration IDs linked to app {app}. slots: app: path.id - text: Return just the accessibility declaration linkages for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/accessibilityDeclarations'].get update: x-apievangelist-phrasing: intent: List an app's accessibility declarations effect: read questions: - What accessibility support has my app declared on the App Store? - Can I filter an app's accessibility declarations by device family or state? instructions: - text: List the accessibility declarations for app {app}. slots: app: path.id - text: Show accessibility declarations for app {app} on device family {device_family}. slots: app: path.id device_family: query.filter[deviceFamily] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/alternativeDistributionKey'].get update: x-apievangelist-phrasing: intent: Get an app's alternative distribution key ID effect: read questions: - Can I get just the ID of the alternative distribution key tied to an app? - Which alternative distribution key identifier is linked to my app? instructions: - text: Get the alternative distribution key ID for app {app}. slots: app: path.id - text: Return only the alternative distribution key linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/alternativeDistributionKey'].get update: x-apievangelist-phrasing: intent: Get an app's alternative distribution key effect: read questions: - Where do I read the public key my app uses for alternative distribution? - What alternative distribution key is set up for my app? instructions: - text: Fetch the full alternative distribution key for app {app}. slots: app: path.id - text: Show the alternative distribution key details of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/analyticsReportRequests'].get update: x-apievangelist-phrasing: intent: List analytics report request IDs for an app effect: read questions: - Can I get only the IDs of the analytics report requests made for an app? - Which analytics report request identifiers exist for my app? instructions: - text: Get the analytics report request IDs for app {app}. slots: app: path.id - text: Return just the analytics report request linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/analyticsReportRequests'].get update: x-apievangelist-phrasing: intent: List an app's analytics report requests effect: read questions: - What analytics report requests have I made for my app? - Can I see only the ongoing or one-time snapshot report requests for an app? instructions: - text: List the analytics report requests for app {app}. slots: app: path.id - text: Show analytics report requests for app {app} with access type {access_type}. slots: app: path.id access_type: query.filter[accessType] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/androidToIosAppMappingDetails'].get update: x-apievangelist-phrasing: intent: List Android-to-iOS mapping IDs for an app effect: read questions: - Can I get only the IDs of the Android-to-iOS mapping details on my app? - Which Android app mapping identifiers are linked to my iOS app? instructions: - text: Get the Android-to-iOS mapping detail IDs for app {app}. slots: app: path.id - text: Return only the Android mapping linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/androidToIosAppMappingDetails'].get update: x-apievangelist-phrasing: intent: List an app's Android-to-iOS app mappings effect: read questions: - Which Android apps have I mapped to my iOS app, and with what package names? - Where can I see the full Android-to-iOS mapping details for an app? instructions: - text: List the Android-to-iOS app mapping details for app {app}. slots: app: path.id - text: Show every Android app mapped to iOS app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appAvailabilityV2'].get update: x-apievangelist-phrasing: intent: Get an app's availability record ID effect: read questions: - Can I get just the ID of an app's availability record? - What is the identifier of the availability resource linked to my app? instructions: - text: Get the availability record ID for app {app}. slots: app: path.id - text: Return only the availability linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appAvailabilityV2'].get update: x-apievangelist-phrasing: intent: Get an app's territory availability effect: read questions: - In which territories is my app available on the App Store? - Does my app automatically become available in new territories? instructions: - text: Show the territory availability of app {app}. slots: app: path.id - text: Fetch the full availability settings for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appClips'].get update: x-apievangelist-phrasing: intent: List App Clip IDs for an app effect: read questions: - Can I get only the IDs of the App Clips that belong to my app? - Which App Clip identifiers are attached to an app? instructions: - text: Get the App Clip IDs for app {app}. slots: app: path.id - text: Return just the App Clip linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appClips'].get update: x-apievangelist-phrasing: intent: List an app's App Clips effect: read questions: - What App Clips does my app have? - Can I find an app's App Clip by its bundle ID? instructions: - text: List the App Clips for app {app}. slots: app: path.id - text: Find the App Clip with bundle ID {clip_bundle_id} in app {app}. slots: app: path.id clip_bundle_id: query.filter[bundleId] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appCustomProductPages'].get update: x-apievangelist-phrasing: intent: List custom product page IDs for an app effect: read questions: - Can I get only the IDs of the custom product pages for my app? - Which custom product page identifiers does my app have? instructions: - text: Get the custom product page IDs for app {app}. slots: app: path.id - text: Return just the custom product page linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appCustomProductPages'].get update: x-apievangelist-phrasing: intent: List an app's custom product pages effect: read questions: - What custom product pages have I set up for my app? - Can I list only the custom product pages that are visible? instructions: - text: List the custom product pages for app {app}. slots: app: path.id - text: Show custom product pages for app {app} where visible is {visible}. slots: app: path.id visible: query.filter[visible] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appEncryptionDeclarations'].get update: x-apievangelist-phrasing: intent: List encryption declaration IDs for an app effect: read questions: - Can I get only the IDs of an app's export compliance declarations? - Which encryption declaration identifiers are linked to my app? instructions: - text: Get the encryption declaration IDs for app {app}. slots: app: path.id - text: Return just the encryption declaration linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appEncryptionDeclarations'].get update: x-apievangelist-phrasing: intent: List an app's encryption declarations effect: read questions: - What export compliance encryption declarations has my app filed? - Can I see the encryption declarations used by a specific build? instructions: - text: List the encryption declarations for app {app}. slots: app: path.id - text: Show encryption declarations for app {app} tied to build {build}. slots: app: path.id build: query.filter[builds] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appEvents'].get update: x-apievangelist-phrasing: intent: List in-app event IDs for an app effect: read questions: - Can I get only the IDs of the in-app events on my app? - Which in-app event identifiers are linked to an app? instructions: - text: Get the in-app event IDs for app {app}. slots: app: path.id - text: Return just the in-app event linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appEvents'].get update: x-apievangelist-phrasing: intent: List an app's in-app events effect: read questions: - What in-app events have I created for my app? - Can I list only the in-app events that are currently published? instructions: - text: List the in-app events for app {app}. slots: app: path.id - text: Show in-app events for app {app} in state {event_state}. slots: app: path.id event_state: query.filter[eventState] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appInfos'].get update: x-apievangelist-phrasing: intent: List app info IDs for an app effect: read questions: - Can I get only the IDs of the app info records on my app? - Which app info identifiers belong to an app? instructions: - text: Get the app info IDs for app {app}. slots: app: path.id - text: Return just the app info linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appInfos'].get update: x-apievangelist-phrasing: intent: List an app's app info records effect: read questions: - Where do I see my app's age rating and category information? - What app info records exist for my app across versions? instructions: - text: List the app info records for app {app}. slots: app: path.id - text: Show the age rating and category info for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appPricePoints'].get update: x-apievangelist-phrasing: intent: List price point IDs for an app effect: read questions: - Can I get only the IDs of the price points available to my app? - Which price point identifiers can my app use? instructions: - text: Get the price point IDs for app {app}. slots: app: path.id - text: Return just the price point linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appPricePoints'].get update: x-apievangelist-phrasing: intent: List an app's available price points effect: read questions: - What price tiers can I charge for my app in a given territory? - What customer price and proceeds does each price point give me? instructions: - text: List the available price points for app {app}. slots: app: path.id - text: Show price points for app {app} in territory {territory}. slots: app: path.id territory: query.filter[territory] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appPriceSchedule'].get update: x-apievangelist-phrasing: intent: Get an app's price schedule ID effect: read questions: - Can I get just the ID of my app's price schedule? - Which price schedule identifier is linked to an app? instructions: - text: Get the price schedule ID for app {app}. slots: app: path.id - text: Return only the price schedule linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appPriceSchedule'].get update: x-apievangelist-phrasing: intent: Get an app's price schedule effect: read questions: - What is my app's current price and base territory? - Are there scheduled price changes coming up for my app? instructions: - text: Show the price schedule for app {app}. slots: app: path.id - text: Fetch the full pricing schedule of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appStoreVersionExperimentsV2'].get update: x-apievangelist-phrasing: intent: List product page test IDs for an app effect: read questions: - Can I get only the IDs of the product page experiments on my app? - Which A/B test identifiers are linked to my app? instructions: - text: Get the product page experiment IDs for app {app}. slots: app: path.id - text: Return just the experiment linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appStoreVersionExperimentsV2'].get update: x-apievangelist-phrasing: intent: List an app's product page optimization tests effect: read questions: - What product page optimization tests are running for my app? - Can I filter my app's A/B tests by state, like completed ones? instructions: - text: List the product page optimization tests for app {app}. slots: app: path.id - text: Show product page tests for app {app} in state {state}. slots: app: path.id state: query.filter[state] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appStoreVersions'].get update: x-apievangelist-phrasing: intent: List App Store version IDs for an app effect: read questions: - Can I get only the IDs of every App Store version of my app? - Which App Store version identifiers are linked to an app? instructions: - text: Get the App Store version IDs for app {app}. slots: app: path.id - text: Return just the App Store version linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appStoreVersions'].get update: x-apievangelist-phrasing: intent: List an app's App Store versions effect: read questions: - What versions of my app exist and what state is each one in? - Can I find a specific version string or filter versions by platform? instructions: - text: List the App Store versions for app {app}. slots: app: path.id - text: Find version {version_string} of app {app} on platform {platform}. slots: app: path.id version_string: query.filter[versionString] platform: query.filter[platform] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/appTags'].get update: x-apievangelist-phrasing: intent: List app tag IDs for an app effect: read questions: - Can I get only the IDs of the tags attached to my app? - Which tag identifiers are linked to an app? instructions: - text: Get the tag IDs for app {app}. slots: app: path.id - text: Return just the tag linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/appTags'].get update: x-apievangelist-phrasing: intent: List an app's App Store tags effect: read questions: - What tags has the App Store assigned to my app? - Can I see only the tags that are visible in the App Store? instructions: - text: List the tags for app {app}. slots: app: path.id - text: Show tags for app {app} where visible in App Store is {visible}. slots: app: path.id visible: query.filter[visibleInAppStore] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/backgroundAssets'].get update: x-apievangelist-phrasing: intent: List background asset IDs for an app effect: read questions: - Can I get only the IDs of the background assets on my app? - Which background asset identifiers belong to an app? instructions: - text: Get the background asset IDs for app {app}. slots: app: path.id - text: Return just the background asset linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/backgroundAssets'].get update: x-apievangelist-phrasing: intent: List an app's background assets effect: read questions: - What background asset packs does my app have? - Can I exclude archived background assets or find one by asset pack identifier? instructions: - text: List the background assets for app {app}. slots: app: path.id - text: Find background asset pack {asset_pack} in app {app}. slots: app: path.id asset_pack: query.filter[assetPackIdentifier] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaAppLocalizations'].get update: x-apievangelist-phrasing: intent: List beta localization IDs for an app effect: read questions: - Can I get only the IDs of my app's beta localizations? - Which TestFlight localization identifiers are linked to an app? instructions: - text: Get the beta localization IDs for app {app}. slots: app: path.id - text: Return just the beta localization linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/betaAppLocalizations'].get update: x-apievangelist-phrasing: intent: List an app's TestFlight localizations effect: read questions: - What TestFlight descriptions and feedback emails do I have per language? - Which languages have beta test information for my app? instructions: - text: List the TestFlight localizations for app {app}. slots: app: path.id - text: Show beta app descriptions in every language for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaAppReviewDetail'].get update: x-apievangelist-phrasing: intent: Get an app's beta review detail ID effect: read questions: - Can I get just the ID of my app's beta app review detail? - Which beta review detail identifier is linked to an app? instructions: - text: Get the beta review detail ID for app {app}. slots: app: path.id - text: Return only the beta review detail linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/betaAppReviewDetail'].get update: x-apievangelist-phrasing: intent: Get an app's beta review contact details effect: read questions: - What contact info and demo account did I give TestFlight beta review? - Where do I check the sign-in details beta reviewers will use? instructions: - text: Show the beta app review details for app {app}. slots: app: path.id - text: Fetch the TestFlight review contact and demo account for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaFeedbackCrashSubmissions'].get update: x-apievangelist-phrasing: intent: List beta crash feedback IDs for an app effect: read questions: - Can I get only the IDs of the crash reports testers submitted for my app? - Which crash feedback identifiers are linked to an app? instructions: - text: Get the beta crash feedback IDs for app {app}. slots: app: path.id - text: Return just the crash submission linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/betaFeedbackCrashSubmissions'].get update: x-apievangelist-phrasing: intent: List an app's TestFlight crash feedback effect: read questions: - What crash reports have TestFlight testers sent for my app? - Can I filter tester crash feedback by device model, OS version or build? instructions: - text: List the TestFlight crash feedback for app {app}. slots: app: path.id - text: Show crash feedback for app {app} from device model {device_model}. slots: app: path.id device_model: query.filter[deviceModel] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaFeedbackScreenshotSubmissions'].get update: x-apievangelist-phrasing: intent: List beta screenshot feedback IDs for an app effect: read questions: - Can I get only the IDs of the screenshot feedback testers sent for my app? - Which screenshot feedback identifiers are linked to an app? instructions: - text: Get the beta screenshot feedback IDs for app {app}. slots: app: path.id - text: Return just the screenshot submission linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/betaFeedbackScreenshotSubmissions'].get update: x-apievangelist-phrasing: intent: List an app's TestFlight screenshot feedback effect: read questions: - What screenshot feedback have TestFlight testers submitted for my app? - Can I see screenshot feedback from one tester or one build only? instructions: - text: List the TestFlight screenshot feedback for app {app}. slots: app: path.id - text: Show screenshot feedback for app {app} on build {build}. slots: app: path.id build: query.filter[build] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaGroups'].get update: x-apievangelist-phrasing: intent: List beta group IDs for an app effect: read questions: - Can I get only the IDs of the beta groups for my app? - Which beta group identifiers are linked to an app? instructions: - text: Get the beta group IDs for app {app}. slots: app: path.id - text: Return just the beta group linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/betaGroups'].get update: x-apievangelist-phrasing: intent: List an app's TestFlight beta groups effect: read questions: - What TestFlight tester groups have I created for my app? - Which beta groups use a public link for my app? instructions: - text: List the TestFlight beta groups for app {app}. slots: app: path.id - text: Show every beta group with its settings for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaLicenseAgreement'].get update: x-apievangelist-phrasing: intent: Get an app's beta license agreement ID effect: read questions: - Can I get just the ID of my app's beta license agreement? - Which beta license agreement identifier is linked to an app? instructions: - text: Get the beta license agreement ID for app {app}. slots: app: path.id - text: Return only the beta license agreement linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/betaLicenseAgreement'].get update: x-apievangelist-phrasing: intent: Get an app's beta license agreement effect: read questions: - What license terms do TestFlight testers agree to for my app? - Where can I read the beta license agreement text for an app? instructions: - text: Show the beta license agreement for app {app}. slots: app: path.id - text: Fetch the TestFlight license agreement text of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/betaTesters'].delete update: x-apievangelist-phrasing: intent: Remove beta testers from an app effect: destructive questions: - How do I remove testers from all TestFlight testing of an app? - Can I revoke several beta testers' access to my app at once? instructions: - text: Remove beta testers {testers} from app {app}. slots: app: path.id testers: requestBody.data - text: Revoke TestFlight access to app {app} for testers {testers}. slots: app: path.id testers: requestBody.data method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/buildUploads'].get update: x-apievangelist-phrasing: intent: List build upload IDs for an app effect: read questions: - Can I get only the IDs of the build uploads for my app? - Which build upload identifiers are linked to an app? instructions: - text: Get the build upload IDs for app {app}. slots: app: path.id - text: Return just the build upload linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/buildUploads'].get update: x-apievangelist-phrasing: intent: List an app's build uploads effect: read questions: - What builds have I uploaded for my app and are they still processing? - Can I find an upload by version and build number? instructions: - text: List the build uploads for app {app}. slots: app: path.id - text: Show build uploads for app {app} with build number {build_number}. slots: app: path.id build_number: query.filter[cfBundleVersion] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/builds'].get update: x-apievangelist-phrasing: intent: List build IDs for an app effect: read questions: - Can I get only the IDs of the processed builds of my app? - What processed build identifiers does an app have, without the full records? instructions: - text: Get the processed build IDs for app {app}. slots: app: path.id - text: Return only build resource identifiers, not uploads, for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/builds'].get update: x-apievangelist-phrasing: intent: List an app's builds effect: read questions: - What builds of my app are in App Store Connect? - Where do I see processed builds with their version numbers for an app? instructions: - text: List the builds for app {app}. slots: app: path.id - text: Show every processed build of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/ciProduct'].get update: x-apievangelist-phrasing: intent: Get an app's Xcode Cloud product ID effect: read questions: - Can I get just the ID of the Xcode Cloud product for my app? - Which CI product identifier is linked to an app? instructions: - text: Get the Xcode Cloud product ID for app {app}. slots: app: path.id - text: Return only the CI product linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/ciProduct'].get update: x-apievangelist-phrasing: intent: Get an app's Xcode Cloud product effect: read questions: - Is my app set up in Xcode Cloud, and what is its CI product? - Where do I find the Xcode Cloud product details for an app? instructions: - text: Show the Xcode Cloud product for app {app}. slots: app: path.id - text: Fetch the full CI product record of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/customerReviewSummarizations'].get update: x-apievangelist-phrasing: intent: Get summaries of an app's customer reviews effect: read questions: - Is there an AI summary of what customers say in my app's reviews? - Can I get review summaries for a specific platform and territory? instructions: - text: Summarize the customer reviews of app {app} on platform {platform}. slots: app: path.id platform: query.filter[platform] - text: Get review summaries for app {app} on {platform} in territory {territory}. slots: app: path.id platform: query.filter[platform] territory: query.filter[territory] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/customerReviews'].get update: x-apievangelist-phrasing: intent: List customer review IDs for an app effect: read questions: - Can I get only the IDs of the customer reviews on my app? - Which customer review identifiers are linked to an app? instructions: - text: Get the customer review IDs for app {app}. slots: app: path.id - text: Return just the customer review linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/customerReviews'].get update: x-apievangelist-phrasing: intent: List an app's customer reviews effect: read questions: - What are customers writing about my app on the App Store? - Can I find one-star reviews I have not responded to yet? instructions: - text: List the customer reviews for app {app}. slots: app: path.id - text: Show reviews of app {app} with rating {rating} in territory {territory}. slots: app: path.id rating: query.filter[rating] territory: query.filter[territory] - text: Show reviews of app {app} without a published response. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/endUserLicenseAgreement'].get update: x-apievangelist-phrasing: intent: Get an app's EULA ID effect: read questions: - Can I fetch only the identifier of the custom end user license on my app? - Which EULA identifier is linked to an app? instructions: - text: Get the end user license agreement ID for app {app}. slots: app: path.id - text: Return only the EULA linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/endUserLicenseAgreement'].get update: x-apievangelist-phrasing: intent: Get an app's custom EULA effect: read questions: - What custom end user license agreement text does my app use? - In which territories does my app's custom EULA apply? instructions: - text: Show the custom end user license agreement of app {app}. slots: app: path.id - text: Fetch the full EULA text and territories for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/gameCenterDetail'].get update: x-apievangelist-phrasing: intent: Get an app's Game Center detail ID effect: read questions: - Can I get just the ID of my app's Game Center detail? - Which Game Center detail identifier is linked to an app? instructions: - text: Get the Game Center detail ID for app {app}. slots: app: path.id - text: Return only the Game Center detail linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/gameCenterDetail'].get update: x-apievangelist-phrasing: intent: Get an app's Game Center configuration effect: read questions: - How is Game Center configured for my app? - Is my app sharing Game Center data through an app group? instructions: - text: Show the Game Center configuration of app {app}. slots: app: path.id - text: Fetch the full Game Center detail record for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/gameCenterEnabledVersions'].get update: x-apievangelist-phrasing: intent: List Game Center enabled version IDs for an app effect: read questions: - Can I get only the IDs of the Game Center enabled versions of my app? - Which Game Center version identifiers are linked to an app? instructions: - text: Get the Game Center enabled version IDs for app {app}. slots: app: path.id - text: Return just the Game Center version linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/gameCenterEnabledVersions'].get update: x-apievangelist-phrasing: intent: List an app's Game Center enabled versions effect: read questions: - Which versions of my app have Game Center turned on? - Can I filter Game Center enabled versions by platform or version string? instructions: - text: List the Game Center enabled versions of app {app}. slots: app: path.id - text: Show Game Center enabled versions of app {app} on platform {platform}. slots: app: path.id platform: query.filter[platform] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/inAppPurchases'].get update: x-apievangelist-phrasing: intent: List in-app purchase IDs for an app (legacy) effect: read questions: - Can I get only the IDs of my app's in-app purchases from the older endpoint? - Which legacy in-app purchase identifiers are linked to an app? instructions: - text: Get the legacy in-app purchase IDs for app {app}. slots: app: path.id - text: Return just the older in-app purchase linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/inAppPurchases'].get update: x-apievangelist-phrasing: intent: List an app's in-app purchases (legacy) effect: read questions: - Can I list in-app purchases through the original version-one endpoint? - Which of my in-app purchases can be submitted, using the legacy list? instructions: - text: List in-app purchases for app {app} using the legacy endpoint. slots: app: path.id - text: Show legacy in-app purchases of type {iap_type} for app {app}. slots: app: path.id iap_type: query.filter[inAppPurchaseType] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/inAppPurchasesV2'].get update: x-apievangelist-phrasing: intent: List in-app purchase IDs for an app (V2) effect: read questions: - Can I get only the IDs of my app's in-app purchases from the V2 relationship? - Which current in-app purchase identifiers belong to an app? instructions: - text: Get the in-app purchase V2 IDs for app {app}. slots: app: path.id - text: Return just the V2 in-app purchase linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/inAppPurchasesV2'].get update: x-apievangelist-phrasing: intent: List an app's in-app purchases effect: read questions: - What in-app purchases does my app sell, and what state is each in? - Can I find an in-app purchase by its product ID? instructions: - text: List the in-app purchases for app {app}. slots: app: path.id - text: Find the in-app purchase with product ID {product_id} in app {app}. slots: app: path.id product_id: query.filter[productId] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/marketplaceSearchDetail'].get update: x-apievangelist-phrasing: intent: Get an app's marketplace search detail ID effect: read questions: - Can I get just the ID of my app's marketplace search detail? - Which marketplace search detail identifier is linked to an app? instructions: - text: Get the marketplace search detail ID for app {app}. slots: app: path.id - text: Return only the marketplace search detail linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/marketplaceSearchDetail'].get update: x-apievangelist-phrasing: intent: Get an app's alternative marketplace search detail effect: read questions: - What catalog URL have I set for my app in alternative marketplace search? - Where can I read my app's marketplace search configuration? instructions: - text: Show the marketplace search detail for app {app}. slots: app: path.id - text: Fetch the alternative marketplace catalog URL configured for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/perfPowerMetrics'].get update: x-apievangelist-phrasing: intent: Get an app's performance and power metrics effect: read questions: - How is my app performing on launch time, hangs and battery in the field? - Can I get performance metrics for just one device type or metric type? instructions: - text: Get performance and power metrics for app {app}. slots: app: path.id - text: Show {metric_type} metrics for app {app} on platform {platform}. slots: app: path.id metric_type: query.filter[metricType] platform: query.filter[platform] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/preReleaseVersions'].get update: x-apievangelist-phrasing: intent: List prerelease version IDs for an app effect: read questions: - Can I get only the IDs of my app's prerelease versions? - Which TestFlight prerelease identifiers are tied to an app? instructions: - text: Get the prerelease version IDs for app {app}. slots: app: path.id - text: Return only the beta prerelease linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/preReleaseVersions'].get update: x-apievangelist-phrasing: intent: List an app's prerelease versions effect: read questions: - What prerelease versions of my app are in TestFlight? - Which beta version numbers have builds for my app? instructions: - text: List the prerelease versions of app {app}. slots: app: path.id - text: Show every TestFlight prerelease version for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/promotedPurchases'].get update: x-apievangelist-phrasing: intent: List promoted purchase IDs for an app effect: read questions: - Can I get only the IDs of my app's promoted purchases, in their order? - Which promoted purchase identifiers are linked to an app? instructions: - text: Get the promoted purchase IDs for app {app}. slots: app: path.id - text: Return just the promoted purchase linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/promotedPurchases'].patch update: x-apievangelist-phrasing: intent: Reorder or replace an app's promoted purchases effect: write questions: - How do I change the order of the in-app purchases promoted on my product page? - Can I replace the whole set of promoted purchases for an app at once? instructions: - text: Set the promoted purchases of app {app} to {promoted_purchases} in that order. slots: app: path.id promoted_purchases: requestBody.data - text: Replace the promoted purchase list on app {app} with {promoted_purchases}. slots: app: path.id promoted_purchases: requestBody.data method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/promotedPurchases'].get update: x-apievangelist-phrasing: intent: List an app's promoted purchases effect: read questions: - Which in-app purchases are promoted on my App Store product page? - What visibility and state does each promoted purchase on my app have? instructions: - text: List the promoted purchases for app {app}. slots: app: path.id - text: Show every promoted in-app purchase with details for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/reviewSubmissions'].get update: x-apievangelist-phrasing: intent: List review submission IDs for an app effect: read questions: - Can I get only the IDs of the review submissions for my app? - Which App Review submission identifiers are linked to an app? instructions: - text: Get the review submission IDs for app {app}. slots: app: path.id - text: Return just the review submission linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/reviewSubmissions'].get update: x-apievangelist-phrasing: intent: List an app's review submissions effect: read questions: - What has my app sent to App Review, and where is each submission? - Can I list my app's review submissions by state or platform? instructions: - text: List the review submissions for app {app}. slots: app: path.id - text: Show review submissions for app {app} in state {state}. slots: app: path.id state: query.filter[state] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/searchKeywords'].get update: x-apievangelist-phrasing: intent: List search keyword IDs for an app effect: read questions: - Can I get only the IDs of the search keywords on my app? - Which keyword identifiers are linked to an app? instructions: - text: Get the search keyword IDs for app {app}. slots: app: path.id - text: Return just the search keyword linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/searchKeywords'].get update: x-apievangelist-phrasing: intent: List an app's search keywords effect: read questions: - What search keywords is my app associated with? - Can I see my app's keywords for one locale or platform? instructions: - text: List the search keywords for app {app}. slots: app: path.id - text: Show search keywords for app {app} in locale {locale}. slots: app: path.id locale: query.filter[locale] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/subscriptionGracePeriod'].get update: x-apievangelist-phrasing: intent: Get an app's grace period setting ID effect: read questions: - Can I get just the ID of my app's subscription grace period setting? - Which grace period identifier is linked to an app? instructions: - text: Get the subscription grace period ID for app {app}. slots: app: path.id - text: Return only the grace period linkage of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/subscriptionGracePeriod'].get update: x-apievangelist-phrasing: intent: Get an app's subscription grace period effect: read questions: - Is billing grace period turned on for my app's subscriptions, and for how long? - Does my app's grace period apply to renewals or just free trials? instructions: - text: Show the subscription grace period settings of app {app}. slots: app: path.id - text: Fetch the billing grace period duration for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/subscriptionGroups'].get update: x-apievangelist-phrasing: intent: List subscription group IDs for an app effect: read questions: - Can I get only the IDs of my app's subscription groups? - Which subscription group identifiers are linked to an app? instructions: - text: Get the subscription group IDs for app {app}. slots: app: path.id - text: Return just the subscription group linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/subscriptionGroups'].get update: x-apievangelist-phrasing: intent: List an app's subscription groups effect: read questions: - What auto-renewable subscription groups does my app offer? - Can I find a subscription group by its reference name? instructions: - text: List the subscription groups for app {app}. slots: app: path.id - text: Find subscription group {reference_name} in app {app}. slots: app: path.id reference_name: query.filter[referenceName] method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/relationships/webhooks'].get update: x-apievangelist-phrasing: intent: List webhook IDs for an app effect: read questions: - Can I get only the IDs of the webhooks registered for my app? - Which webhook identifiers are linked to an app? instructions: - text: Get the webhook IDs for app {app}. slots: app: path.id - text: Return just the webhook linkages of app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/webhooks'].get update: x-apievangelist-phrasing: intent: List an app's webhooks effect: read questions: - What webhooks are set up to notify me about my app's events? - Where can I see the URLs and event types of my app's webhooks? instructions: - text: List the webhooks for app {app}. slots: app: path.id - text: Show every webhook with its URL and events for app {app}. slots: app: path.id method: generated generated: '2026-10-01' - target: $.paths['/v1/apps/{id}/metrics/betaTesterUsages'].get update: x-apievangelist-phrasing: intent: Get beta tester usage metrics for an app effect: read questions: - How actively are TestFlight testers using my app? - Can I break tester usage down by period or by individual tester? instructions: - text: Get beta tester usage metrics for app {app}. slots: app: path.id - text: Show tester usage for app {app} over period {period} grouped by {group_by}. slots: app: path.id period: query.period group_by: query.groupBy method: generated generated: '2026-10-01'