Themes
Retrieve a list of themes
Required scope: themes:read
Organization authorization: supported
query Parameters
pagepage number to retrieve (starts with 0)
perPagenumber of items per page (between 1 and 100, default 10)
operatorIdAllows filtering themes by operatorId.
*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.
Retrieve a list of themes › Responses
List of themes that match the criteria
Create a theme
Creates a new theme for the operator. Image fields accept base64-encoded data URLs (data:image/png;base64,...); supported MIME types are image/png, image/jpeg, image/svg+xml; maximum 4 MB per image.
Required scope: themes:write
Organization authorization: supported
Create a theme › Request Body
nameName of the theme
app_primary_colorPrimary colour for the app
app_secondary_colorSecondary colour for the app
portal_primary_colorPrimary colour for the portal
portal_secondary_colorSecondary colour for the portal
app_imageApp logo as a base64-encoded data URL. Allowed MIME types: image/png, image/jpeg, image/svg+xml. Max 4 MB.
portal_imagePortal logo as a base64-encoded data URL.
portal_fav_iconPortal favicon as a base64-encoded data URL.
defaultsidebar_theming_enabledWhether sidebar theming is enabled
Create a theme › Responses
Created theme
nameName of the theme
titleTitle of the theme formatted with operator name
primaryColorPrimary color in HEX format
secondaryColorSecondary color in HEX format
logoUrlUrl of the logo image
favIconUrlUrl of the favicon image
Operator associated with the theme
idUnique identifier of the theme
Retrieve a single theme
Required scope: themes:read
Organization authorization: supported
path Parameters
themeIdRetrieve a single theme › Responses
Theme with provided id
nameName of the theme
titleTitle of the theme formatted with operator name
primaryColorPrimary color in HEX format
secondaryColorSecondary color in HEX format
logoUrlUrl of the logo image
favIconUrlUrl of the favicon image
Operator associated with the theme
idUnique identifier of the theme
Update a theme
Partially updates a theme. Only provided fields are changed; image fields, when provided, must be base64-encoded data URLs and replace the corresponding stored asset.
Required scope: themes:write
Organization authorization: supported
path Parameters
themeIdUpdate a theme › Request Body
nameName of the theme
defaultsidebar_theming_enabledWhether sidebar theming is enabled
app_primary_colorPrimary colour for the app
app_secondary_colorSecondary colour for the app
portal_primary_colorPrimary colour for the portal
portal_secondary_colorSecondary colour for the portal
app_imageReplacement app logo as a base64-encoded data URL
portal_imageReplacement portal logo as a base64-encoded data URL
portal_fav_iconReplacement portal favicon as a base64-encoded data URL
Update a theme › Responses
Updated theme
nameName of the theme
titleTitle of the theme formatted with operator name
primaryColorPrimary color in HEX format
secondaryColorSecondary color in HEX format
logoUrlUrl of the logo image
favIconUrlUrl of the favicon image
Operator associated with the theme
idUnique identifier of the theme