Skip to content

Get brands list

GetBrandsList

Description: Returns a list of all branding configurations in the platform. Each record includes branding metadata such as name, domain host URLs, logo paths, status, and creation time.

Access Control

🛡️ Access Level Required: SESSION_ADMIN


Endpoint

GET::/brands


Response Parameters (per record)

Field Type Description
brand string Name of the brand
terminal_host string Terminal access host URL
crm_host string CRM host URL
light_logo string Path or URL to light mode logo
dark_logo string Path or URL to dark mode logo
favicon string Path or URL to favicon
status int Status flag (e.g., 1 for active, 0 for off)
create_time int Unix timestamp of brand creation

Response Example

{
  "rows": [
    {
      "brand": "IonMarkets",
      "terminal_host": "https://terminal.ionmarkets.com",
      "crm_host": "https://crm.ionmarkets.com",
      "light_logo": "/images/ion-light.svg",
      "dark_logo": "/images/ion-dark.svg",
      "favicon": "/images/favicon.ico",
      "status": 1,
      "create_time": 1698662400
    }
  ]
}

Error Example

{
  "error": "INVALID_DATA",
  "message": "Validation error"
}