v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
apps_management_Preferred Regions

Get Preferred Regions for Tenant

⚠️ Apple devices only.

Retrieves the tenant's current list of preferred App Store regions, returning an empty countries array if no regions have been configured. Use this endpoint to inspect the tenant's configured storefronts before assigning or updating per-app regions, and to verify that a desired country code is available before calling PUT /v2/itunesapps/{appleAppId}/preferred-region.

About Preferred Regions

The preferred regions list defines the pool of up to five App Store storefronts a tenant can use when assigning regions to individual VPP apps. This read endpoint surfaces the current state of that list — including the country codes, the user who last modified it, and timestamps. An empty countries array indicates no preferred regions have been set, meaning per-app region assignments cannot be made until regions are configured via POST /v2/preferred-regions. In the Console, this configuration is visible in Apple MDM Management settings.

Key Fields

tenant_id (response) — UUID of the tenant

countries (response) — array of uppercase ISO 3166-1 alpha-2 country codes currently configured (e.g., ["AU", "IN", "US"]); empty array if none set

created_by / updated_by — UUID of the user who created or last modified the list

created_at / updated_at — timestamps of creation and last update

Common Use Cases

Verifying which App Store storefronts are currently available before assigning a region to a VPP app

Auditing the tenant's region configuration as part of an iOS fleet compliance check

Checking whether a preferred region list has been set up at all during initial iOS VPP onboarding

Best Practices

Call this endpoint before any PUT /v2/itunesapps/{appleAppId}/preferred-region operation to confirm the target country code is in the list

Include this in onboarding checklists: an empty countries response means VPP region assignments are not yet possible

Use the updated_at timestamp to detect whether the list has changed since your last sync

Workflow

GET /v2/preferred-regions to retrieve the current country list

Confirm the desired storefront country code is present before assigning it to a VPP app

If the list is empty or missing the needed country, configure it via POST /v2/preferred-regions first

get/v2/preferred-regions

Response

Success

Example response

{
  "content": {
    "countries": [
      "AU",
      "IN",
      "US"
    ]
  }
}