Brand Location Groups

Prev Next
Get
/public/v1/brand-management/location-groups

Retrieves a paginated list of brand location groups with their subgroups and location assignments. Use the continuationToken from the previous response to retrieve the next page.

Security

The requesting user must have the following permission to retrieve brand location groups:

  • Administration → View Brand Manager
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
ContinuationToken
string

Pagination token from a previous response. Omit to start from the first page

Responses
200

Brand Location Groups

Expand All
object
brandLocationGroups
Array of object (LocationGroup)
object
brandLocationGroupId
integer (int64)
brandLocationGroupName
string
description
string
subgroups
Array of object (Subgroup)
object
subgroupId
integer (int64)
name
string

Display name of the subgroup.

Level
integer (int32)
options
Array of object (Option)
object
subgroupId
integer (int64)
optionId
integer (int64)
value
string
locations
Array of string | null
string (uuid)
children
Array of object (Option)
nextPage
string (uri) | null

URL to retrieve the next page of results, or null when this is the last page.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.