Get Brands

Description

This services returns a list of available brands with optional filtering via query parameters.

---

Request

Endpoint

GET https://<server-url>/api/v4/referencedata/brands

Parameters

All parameters for this endpoint are optional and are sent via the query string.

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint making the request. If sent as a header, the name must be Thalamus-Touchpoint.
token	Query / Header	The authentication token for the API. If sent as a header, the name must be Thalamus-Token.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.
marketid	Query	Optional. An integer used to retrieve the tree for a specific market by its ID.
brandfamilyid	Query	Optional. An integer used to retrieve the tree for a specific brand family by its ID.
brandid	Query	Optional. An integer used to retrieve the tree for a specific brand by its ID.
productdid	Query	Optional. An integer used to retrieve the tree for a specific product by its ID.

Full URL Example

http://localhost:8080/thalamus/api/v4/referencedata/brands?marketid=1&branfamilyid=1&brandid=1&touchpoint=test&token=testtesttesttesttesttesttesttesttesttesttesttesttesttesttesttest

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON object is returned, with the corresponding brands.

Field	Type	Description
name	String	The name of the brand.
id	Number	The unique identifier for the brand.

JSON

[
    {
        "name": "Red Bull",
        "id": 1
    },
    {
        "name": "Speed",
        "id": 2
    },
    {
        "name": "E",
        "id": 3
    },
    {
        "name": "E Light",
        "id": 4
    },
    {
        "name": "Caffeine",
        "id": 5
    }
]