---
updatedAt: 2024-11-18T16:27:11.000Z
agentTools:
  projectIndex: https://docs-cpm.dataguard.com/llms.txt
---

# Get the branding style.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "servers": [
    {
      "url": "api.consentric.io"
    }
  ],
  "info": {
    "version": "1.0",
    "title": "Customer Engagement",
    "license": {
      "name": "(c) 2025 DataGuard. All Rights Reserved."
    }
  },
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "header"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "api_key": []
    },
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/v1/branding": {
      "get": {
        "tags": [
          "Branding"
        ],
        "summary": "Get the branding style.",
        "parameters": [
          {
            "name": "applicationId",
            "in": "query",
            "description": "The ID associated with the target Application.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "d8BNrPqsgRZ"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "cardLayout": {
                      "type": "object",
                      "properties": {
                        "organizationName": {
                          "type": "string",
                          "example": "My Example Org."
                        },
                        "fontFamily": {
                          "type": "string",
                          "example": "Vivaldi"
                        },
                        "logoUrl": {
                          "type": "string",
                          "format": "url",
                          "example": "https://example.com/logo.png"
                        },
                        "color": {
                          "type": "object",
                          "properties": {
                            "confirmButtonBackground": {
                              "type": "string"
                            },
                            "confirmButtonText": {
                              "type": "string"
                            },
                            "contentCardBackground": {
                              "type": "string"
                            },
                            "contentCardText": {
                              "type": "string"
                            },
                            "backdropBackground": {
                              "type": "string"
                            },
                            "headerBackground": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    "styles": {
                      "type": "object",
                      "properties": {
                        "backgroundColor": {
                          "type": "object",
                          "properties": {
                            "primary": {
                              "type": "string"
                            },
                            "secondary": {
                              "type": "string"
                            }
                          }
                        },
                        "textColor": {
                          "type": "object",
                          "properties": {
                            "primary": {
                              "type": "string"
                            },
                            "secondary": {
                              "type": "string"
                            }
                          }
                        },
                        "fontFamily": {
                          "type": "string",
                          "example": "Vivaldi"
                        },
                        "logoUrl": {
                          "type": "string",
                          "format": "url",
                          "example": "https://example.com/logo.png"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  }
}
```