Connected Tenants and Locations

Prev Next
Get
/public/v1/brand-management/connected-tenants-locations

Retrieves a paginated list of tenants and their locations that have subscribed to the authenticated brand. Use the continuationToken from the previous response to retrieve the next page.

Security

No permission is documented for this endpoint. Access is gated at the instance level — the endpoint rejects requests from an instance that does not own a brand.

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

Connected Brand tenants and their locations (paginated).

Expand All
object

Paged list of brand subscription locations.

entities
Array of object (BrandSubscriptionLocation)

Items on the current page.

object
tenantId
integer (int32)

Unique identifier of the tenant.

tenantName
string

Tenant display name.

locations
Array of object (ConnectedTenantLocation)
object
id
string (uuid)

Unique identifier of the location.

number
string

Number assigned to the location.

name
string

Display name of the location.

nextPage
string (uri) | null

Absolute URL for the next page of results. Null/omitted when there is no next page.

Expand All
object

Paged list of brand subscription locations.

entities
Array of object (BrandSubscriptionLocation)

Items on the current page.

object
tenantId
integer (int32)

Unique identifier of the tenant.

tenantName
string

Tenant display name.

locations
Array of object (ConnectedTenantLocation)
object
id
string (uuid)

Unique identifier of the location.

number
string

Number assigned to the location.

name
string

Display name of the location.

nextPage
string (uri) | null

Absolute URL for the next page of results. Null/omitted when there is no next page.

Expand All
object

Paged list of brand subscription locations.

entities
Array of object (BrandSubscriptionLocation)

Items on the current page.

object
tenantId
integer (int32)

Unique identifier of the tenant.

tenantName
string

Tenant display name.

locations
Array of object (ConnectedTenantLocation)
object
id
string (uuid)

Unique identifier of the location.

number
string

Number assigned to the location.

name
string

Display name of the location.

nextPage
string (uri) | null

Absolute URL for the next page of results. Null/omitted when there is no next 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.