---
title: List brands
slug: andrei/list-brands
createdAt: 2026-10-05T10:36:01.732Z
---

{
  "id": "zPRVuXPtQ1DnxBmjPPhe5",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.detected.app/api/v2/public/brands",
    "servers": [
      {
        "url": "https://api.detected.app/api/v2/public/brands",
        "description": "Production"
      }
    ],
    "name": "List brands",
    "description": "<p>Returns the brands configured for your account, including their logos, fonts and the styling of buttons and inputs.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "AccessToken",
          "name": "AccessToken",
          "kind": "optional",
          "type": "http",
          "description": "<p>The API uses OAuth 2.0. Request an access token from <code>POST /oauth/token</code> with the client ID and client secret of your integration client, and your account slug. Send the access token in the <code>Authorization</code> header of every request, in the format <code>Authorization: Bearer &#x3C;access_token></code>. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "headers": [
          {
            "kind": "optional",
            "name": "X-RateLimit-Limit",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "X-RateLimit-Remaining",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "x-ratelimit-reset",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "retry-after",
            "description": ""
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "List of brands",
                "modelRef": "#/components/schemas/BrandResource",
                "customType": "BrandResource[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string",
                    "description": "Brand ID."
                  },
                  {
                    "name": "name",
                    "kind": "required",
                    "type": "string",
                    "description": "Brand name."
                  },
                  {
                    "name": "slug",
                    "kind": "required",
                    "type": "string",
                    "description": "Brand slug."
                  },
                  {
                    "name": "is_default",
                    "kind": "required",
                    "type": "boolean",
                    "description": "Whether this brand is the default for the account."
                  },
                  {
                    "name": "configuration",
                    "kind": "required",
                    "type": "object",
                    "description": "Brand configuration data.",
                    "example": "",
                    "schema": [
                      {
                        "name": "logo",
                        "kind": "optional",
                        "type": "object",
                        "description": "Logo configuration.",
                        "example": "",
                        "schema": [
                          {
                            "name": "url",
                            "kind": "optional",
                            "type": "string",
                            "description": "Logo URL location."
                          },
                          {
                            "name": "size",
                            "kind": "optional",
                            "type": "string<default | small | large>",
                            "description": "Logo size.",
                            "enum": [
                              "default",
                              "small",
                              "large"
                            ]
                          }
                        ]
                      },
                      {
                        "name": "inputs",
                        "kind": "optional",
                        "type": "object",
                        "description": "Inputs configuration.",
                        "example": "",
                        "schema": [
                          {
                            "name": "text",
                            "kind": "optional",
                            "type": "object",
                            "description": "Text input configuration.",
                            "example": "",
                            "schema": [
                              {
                                "name": "corners",
                                "kind": "optional",
                                "type": "string<square | curved | round>",
                                "description": "Corner style.",
                                "enum": [
                                  "square",
                                  "curved",
                                  "round"
                                ]
                              },
                              {
                                "name": "border-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Border hex colour."
                              },
                              {
                                "name": "background-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Background hex colour."
                              },
                              {
                                "name": "border-color-focus",
                                "kind": "optional",
                                "type": "string",
                                "description": "Border hex colour on focus."
                              }
                            ]
                          },
                          {
                            "name": "checkboxes",
                            "kind": "optional",
                            "type": "object",
                            "description": "Checkbox input configuration.",
                            "example": "",
                            "schema": [
                              {
                                "name": "icon-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Icon hex colour."
                              },
                              {
                                "name": "background-color-focus",
                                "kind": "optional",
                                "type": "string",
                                "description": "Background hex colour on focus."
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "buttons",
                        "kind": "optional",
                        "type": "object",
                        "description": "Buttons configuration.",
                        "example": "",
                        "schema": [
                          {
                            "name": "primary_button",
                            "kind": "optional",
                            "type": "object",
                            "description": "Primary button configuration.",
                            "example": "",
                            "schema": [
                              {
                                "name": "glow",
                                "kind": "optional",
                                "type": "boolean",
                                "description": "Whether the button has a glow effect."
                              },
                              {
                                "name": "color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Text hex colour."
                              },
                              {
                                "name": "corners",
                                "kind": "optional",
                                "type": "string<square | curved | round>",
                                "description": "Corner style.",
                                "enum": [
                                  "square",
                                  "curved",
                                  "round"
                                ]
                              },
                              {
                                "name": "border-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Border hex colour."
                              },
                              {
                                "name": "background-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Background hex colour."
                              }
                            ]
                          },
                          {
                            "name": "secondry_button",
                            "kind": "optional",
                            "type": "object",
                            "description": "Secondary button configuration.",
                            "example": "",
                            "schema": [
                              {
                                "name": "glow",
                                "kind": "optional",
                                "type": "boolean",
                                "description": "Whether the button has a glow effect."
                              },
                              {
                                "name": "corners",
                                "kind": "optional",
                                "type": "string<square | curved | round>",
                                "description": "Corner style.",
                                "enum": [
                                  "square",
                                  "curved",
                                  "round"
                                ]
                              },
                              {
                                "name": "border-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Border hex colour."
                              },
                              {
                                "name": "background-color",
                                "kind": "optional",
                                "type": "string",
                                "description": "Background hex colour."
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "name": "fonts",
                    "kind": "required",
                    "type": "object",
                    "description": "<p>Fonts configured for the brand, keyed by font type.</p>",
                    "example": "",
                    "schema": []
                  },
                  {
                    "name": "created_at",
                    "kind": "required",
                    "type": "string",
                    "description": "Date and time the brand was created."
                  },
                  {
                    "name": "updated_at",
                    "kind": "required",
                    "type": "string",
                    "description": "Date and time the brand was last updated."
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The access token is missing, invalid or has expired.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "429",
        "description": "<p>Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.detected.app/api/v2/public/brands \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.detected.app/api/v2/public/brands\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.detected.app/api/v2/public/brands\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.detected.app/api/v2/public/brands\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n{\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"name\": \"\",\n      \"slug\": \"\",\n      \"is_default\": false,\n      \"configuration\": {\n        \"logo\": {\n          \"url\": \"\",\n          \"size\": \"\"\n        },\n        \"inputs\": {\n          \"text\": {\n            \"corners\": \"\",\n            \"border-color\": \"\",\n            \"background-color\": \"\",\n            \"border-color-focus\": \"\"\n          },\n          \"checkboxes\": {\n            \"icon-color\": \"\",\n            \"background-color-focus\": \"\"\n          }\n        },\n        \"buttons\": {\n          \"primary_button\": {\n            \"glow\": false,\n            \"color\": \"\",\n            \"corners\": \"\",\n            \"border-color\": \"\",\n            \"background-color\": \"\"\n          },\n          \"secondry_button\": {\n            \"glow\": false,\n            \"corners\": \"\",\n            \"border-color\": \"\",\n            \"background-color\": \"\"\n          }\n        }\n      },\n      \"fonts\": {},\n      \"created_at\": \"\",\n      \"updated_at\": \"\"\n    }\n  ]\n}"
        },
        {
          "id": "response-1-401",
          "language": "401",
          "code": "// Unauthorized. The access token is missing, invalid or has expired.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-429",
          "language": "429",
          "code": "// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}