Skip to main content
GET
/
v3
/
brands
Browse Brands
curl --request GET \
  --url http://localhost/api/v3/brands
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "handle": "<string>",
      "external_id": "<string>",
      "external_code": "<string>",
      "is_system": true,
      "description": "<string>",
      "short_description": "<string>",
      "url": "<string>",
      "image_url": "<string>",
      "internal_note": "<string>",
      "meta": [
        "<unknown>"
      ],
      "departments": [
        {
          "id": 123,
          "name": "<string>",
          "handle": "<string>",
          "external_id": "<string>",
          "external_code": "<string>",
          "description": "<string>",
          "short_description": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "internal_note": "<string>",
          "meta": [
            "<unknown>"
          ],
          "brand_id": 123,
          "location_id": 123,
          "brand": {
            "name": "<string>",
            "handle": "<string>"
          },
          "created_at": "<string>",
          "updated_at": "<string>"
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
page[size]
string

Response

Array of Brand

​
data
Brand · object[]
required