# Search through all LocationGroups

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

Endpoint: GET /location-groups
Version: 20250708
Security: Authorization

## Query parameters:

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

  - `locationGroupIds` (array)
    Used for restricting the returned location groups within the given range of IDs.

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

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

  - `offset` (integer)
    Used for pagination, specifies the starting point from which the returned subset should start.

  - `page` (integer)
    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.

  - `sort` (string)
    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".

  - `order` (string)
    Used for specify the sorting direction in which the list entries shall be returned, possible values ['ASC', 'DESC'].

  - `hideLocations` (boolean)
    If given true value the endpoint will not return the locations array as part of the response, just the group id and name

## Response 200 fields (*/*):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `warnings` (array)
    (optional) Holds further warnings

  - `response` (object, required)
    The actual response object of the response

  - `response.locationGroups` (array)
    The location groups

  - `response.locationGroups.id` (integer)
    ID of the LocationGroup.

  - `response.locationGroups.lastUpdated` (string)
    Last updated date of the Location Group

  - `response.locationGroups.name` (string)
    Name of the LocationGroup.

  - `response.locationGroups.status` (string)
    Status of the Location Group
    Enum: "ACTIVE", "DELETED"

  - `response.locationGroups.users` (array)

  - `response.locationGroups.users.id` (integer)
    ID of the user
    Example: 1

  - `response.locationGroups.users.email` (string)
    Email of the user
    Example: "jan.didschuneit@uberall.com"

  - `response.locationGroups.users.firstName` (string)
    First name of the user
    Example: "Jan"

  - `response.locationGroups.users.lastName` (string)
    Last name of the user
    Example: "Didschuneit"

  - `response.locationGroups.users.role` (string)
    Different roles a user account can have in the system.
    Enum: "UBER_API_ADMIN", "API_ADMIN", "ADMIN", "ACCOUNT_MANAGER", "BUSINESS_MANAGER", "LOCATION_MANAGER", "BUSINESS_MANAGER_INBOX"

  - `response.locationGroups.users.status` (string)
    User Status Enum
    Enum: "INVITED", "CREATED", "VERIFIED", "UNVERIFIED", "INACTIVE", "DELETED", "NO_LOGIN"

  - `response.locationGroups.creator` (integer)

  - `response.locationGroups.salesPartner` (integer)

  - `response.locationGroups.locationsCount` (integer)

  - `response.locationGroups.locations` (array)

  - `response.locationGroups.locations.id` (integer)
    ID of the location
    Example: 1

  - `response.locationGroups.locations.name` (string)
    Name of the location
    Example: "Location 1"

  - `response.locationGroups.locations.status` (string)
    Status of the location
    Enum: "CREATED", "ACTIVE", "INACTIVE", "CANCELLED", "DELETED", "CLOSED"

  - `response.count` (integer)
    The total number of location groups

  - `response.pageSize` (integer)
    The number of location groups per page

  - `response.max` (integer)
    The maximum number of location groups

  - `response.offset` (integer)
    The offset

  - `response.page` (integer)
    The page

## Response 400 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 401 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 403 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 404 fields (application/json):

  - `status` (string, required)
    Enum: "SUCCESS", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response