v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13114857.3 KB
accounts

Lists the locations for the specified account.

get/v1/{+parent}/locations

Path parameters

parentstring required

Required. The name of the account to fetch locations from. * Specific Account ID: If the account is of type AccountType.PERSONAL, the response returns only locations directly owned by that account. For all other types (e.g., AccountType.LOCATION_GROUP), it returns all accessible locations. * Wildcard (-): Using accounts/- identifies the authenticated user. This scope defaults to AccountType.PERSONAL but includes both directly and indirectly owned locations (e.g., those accessible via member groups).

Query parameters

filterstring

Optional. A filter constraining the locations to return. The response includes only entries that match the filter. If filter is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see Work with Location Data Guide.

orderBystring

Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"

pageSizeinteger

Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.

pageTokenstring

Optional. If specified, it fetches the next page of locations. The page token is returned by previous calls to ListLocations when there were more locations than could fit in the requested page size.

readMaskstring

Required. Read mask to specify what fields will be returned in the response.

Response

Successful response