--- title: Query Location Groups framework: Apple Ads Platform API role: symbol role_heading: Web Service Endpoint platforms: [apple ads platform api 1.0+] path: apple-ads-platform-api/query-location-groups --- # Query Location Groups Retrieve a paginated list of location groups using filters and sorting. ## URL POST https://api.ads.apple.com/v1/location-groups/query ## Header Parameters X-Ap-Context: ## Response Codes 200 OK: 400 Bad Request: 401 Unauthorized: 403 Forbidden: 404 Not Found: 429 Too Many Requests: 500 Internal Server Error: ## Discussion Discussion This endpoint returns a paginated list of location groups accessible to the authenticated ad account. An empty request body returns all non-deleted groups with default pagination applied. See QueryFilterOperator for the full set of supported comparison operators. Request Body See QueryRequest. | | | | | | | | | | | | Filterable Fields The system combines multiple filters with AND logic. The id filter matches the group’s system-assigned identifier, the same id value returned in create and get responses, not the provider object ID. Filtering by brandId is the most common way to scope results to a single brand’s groups. The system excludes soft-deleted groups from results by default. To include them, add a filter with field: "deleted", operator: "EQUALS", value: true. note: There’s no dedicated filter for looking up location groups by location membership. To determine which groups contain a specific location, query location groups scoped to the location’s brand with a brandId filter, then inspect each returned group’s membership client-side. For STATIC groups, check whether the location’s id appears in the group’s locationIds array. For DYNAMIC groups, check whether the location satisfies the group’s rules criteria. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sorting and Pagination You can sort results by any filterable field using the sorting array; see QuerySort (QuerySortOrder) and QueryPagination for the request shape. The response includes a pagination object with totalCount, offset, and pageSize. Page through large result sets by incrementing offset. Payload Examples ## See Also - [Create Location Group](apple-ads-platform-api/create-location-group.md) - [Get Location Group](apple-ads-platform-api/get-location-group-by-id.md) - [Update Location Group](apple-ads-platform-api/update-location-group.md) - [Delete Location Group](apple-ads-platform-api/delete-location-group.md)