Query App Locale Details
Return the default product page locale details for an app identified by its adamId.
URL
POST https://api.ads.apple.com/v1/apps/{adamId}/locale-details/queryPath Parameters
| Name | Type | Description |
|---|---|---|
adamId Required | int64 |
Header Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AppLocaleDetailsQueryResponse | |
| 400 | Bad Request Content-Type: application/json | AppLocaleDetailsQueryResponse | |
| 401 | Unauthorized Content-Type: application/json | Error | |
| 403 | Forbidden Content-Type: application/json | Error | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Too Many Requests Content-Type: application/json | Error | |
| 500 | Internal Server Error Content-Type: application/json | Error |
Discussion
This endpoint returns the default product page locale details for an app identified by its adamId. The default product page represents the app’s main App Store listing: the page that all users see unless directed to a custom product page.
In App Store Connect, there is no explicit “default product page” entity. The app’s main listing is the default. This endpoint surfaces that listing through the same AppLocaleDetails structure, so the response format is consistent across both endpoints.
To quickly fetch the default page content for an app without needing to first look up the product page ID, use this endpoint. Each object in the result corresponds to one supported language for the default product page.
Keep the following constraints in mind when querying default locale details:
Constraint | Detail |
|---|---|
Default page only | This endpoint returns only the default product page. Custom product pages require the Query Product Page Locale Details endpoint. |
All locales returned | This endpoint returns all locales configured for the default product page. Filter by |
assetsByDevice structure | The |
See QueryFilterOperator for the full set of supported comparison operators.
Filterable Fields
Field | Type | Operators | Sortable | Description |
|---|---|---|---|---|
| string | Filter to a specific locale, such as |
The adamId field identifies the app via the URL path (/v1/apps/{adamId}/locale-details/query), not a request body filter. The request body is a QueryRequest composed of QueryFilter conditions and QuerySort directives (QuerySortOrder), controlled by QueryPagination.