Branding profiles

Branding profiles describe corporate branding and grouping for your customers.

Branding profile

A branding profile determines a provider's visual corporate identity in the Customer Portal and lets a provider differentiate product pricing for connected customers.

id	string <uuid> Branding Profile identifier.
name	string [ 1 .. 255 ] characters Name of the branding profile.

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Remote Diagnostics"
}

Retrieve all branding profiles

Retrieve a list of branding profiles.

SecurityApiKey and OAuth2

Request

query Parameters

limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
property name* additional property	any

Array of objects (Branding profile) >= 0 items

List of branding profiles.

Array (>= 0 items)

id	string <uuid> Branding Profile identifier.
name	string [ 1 .. 255 ] characters Name of the branding profile.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/providers/branding-profiles

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Remote Diagnostics"
}
],
"total": 3255
}

Retrieve a branding profile

Retrieve a branding profile by its identifier.

SecurityApiKey and OAuth2

Request

path Parameters

branding-profile-id

required

string <uuid>

Branding profile identifier.