v1

latestOpenAPI 3.0.1Licensed under Uberall2026-08-0629353914.0 MB
Location Groups

Search through all LocationGroups

Can be used to search for specific location groups or even return all, depending on the given params.

get/location-groups

Query parameters

fieldMaskstring[]

Used for bypassing pagination and reducing the response objects (List of String), following are supported ["id", "name"]

locationGroupIdsinteger[]

Used for restricting the returned location groups within the given range of IDs.

querystring

Used for searching for a specific keyword within the location group names, only groups matching the given query via 'like' will be returned.

maxinteger

Used for pagination, specifies the amount of entries maximum returned per page (must be between 0-100).

offsetinteger

Used for pagination, specifies the starting point from which the returned subset should start.

pageinteger

Used for pagination, specifies which page you want to get back from a set of pages. Can be used instead of using "offset". Can also be used in combination with "max" otherwise default "max" is being used. Difference to "offset" is that you don't need to calculate the correct value, you can simply request page number 2 with max 10 result in it (page: 2, max: 10). So you will get back results 10-19 while skipping the first 10 (0-9) ones.

sortstring

Used for specify the field by which the list entries shall be sorted, possible values ["NAME", "LAST_UPDATED", "LOCATION_SIZE", "USER_SIZE"]. If none or invalid given list will automatically sorted by "id".

orderstring

Used for specify the sorting direction in which the list entries shall be returned, possible values ['ASC', 'DESC'].

hideLocationsboolean

If given true value the endpoint will not return the locations array as part of the response, just the group id and name

Response

LocationGroups successfully retrieved