GET organisation/portal_settings/show

Available from CRM.COM R15.0.0

This method returns the portal settings (i.e. portal logo and theme) information

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method. The supported options are
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

Response Data

Name

Type

Description

portal_theme

String

The theme that will be used on the portal

The available options are the following

theme-blue
theme-red
theme-green
theme-yellow
theme-purple

portal_logo

Object

The logo that will be used on the related portal components

Referred Objects Response Data

portal logo object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

Examples

Example 1

HTTP Method: GET

Request

Response

 {
    "data": {
        "portal_logo": {
            "file_name": "1_key_portal-logo_CRM_Logo_Portal.jpg",
            "file_content_url": "/crm/ImageDownloadServlet?id=1&filename=key_portal_logo",
            "file_mime_type": "image/jpeg"
        },
        "portal_theme": "theme-blue"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Note

To retrieve or display the actual image you need to construct the following URL

{{server}}{{file_content_url}}&token={{token}}

for example

https://r15qa.crm.com/crm/ImageDownloadServlet?id=1&token=B18ECEE5918442A0A29B7C1B2D0A4260