Get the Branding List

Retrieves the brand list of a specified owner, including the built-in Yeastar brand.

Request URL

GET {base_url}/uc-user/api/v1/branding/list

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code No String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Query parameters
Parameter Required Type Description
ownerUcId No String The UC ID of the brand owner. If omitted, the brands of the current account are returned. You can obtain the ID using the Get the Current User interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Array<Brand_Item> The list of brands.
Brand_Item
Parameter Type Description
id String The ID of the brand.
name String The name of the brand.
ucId String The UC ID of the brand owner. This parameter is returned only for a custom brand.
isYeastar Boolean

Whether the brand is the built-in Yeastar brand.

  • true: The brand is the built-in Yeastar brand.
  • false: The brand is a custom brand.

Example

Request example

GET /uc-user/api/v1/branding/list HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzcyNjA2NiwiaWF0IjoxNzkzNzA0NDY2LCJqdGkiOiIxMWY0Zjg5NS1iZjg3LTRmMzItODc1MS1mN2YxOTY2MTM2MTUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.MvcRJ65X45nvneeknNK0vUo8AY4uLIUkGUzkQmspfBfSqiI7P8q2dVKMldjKeB-9JNr91h2xFpfzbz_1CstSkM0l7QpZuK9aLOjCsDlY0C2FPfZHOdS0gggUAT7SlG1vReEXK4zs0uCWZ6FZUhyDv3R1EDHGYQVd_Qb7mxXxLIvnqwlXC9Txei8qqvAT8dTEpZmKnI2wyPdBvhg7MFhVIUgei8JhZrrJtWglt0lmxxBsPcKZkJXWs75ZH4j2zsMOQf6klkXDdpOgQUIrQI9PsLrSlRX94FRJ4PvqQbHJtme9bXi6jkTiY1aykDeHA3fxX70SyAJ8MXsBLDRdEMdM_w
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "id": "2089256397261770753",
      "name": "Colorbrand",
      "ucId": "3076913644890832896",
      "isYeastar": false
    },
    {
      "id": "0",
      "name": "Yeastar",
      "isYeastar": true
    }
  ],
  "requestId": "1103b4f91480d865d2a15a66a1bdb6e6",
  "code": "200",
  "message": "SUCCESS"
}