---
title: Brands
slug: brands
docTags: 
createdAt: 2022-04-14T07:56:18.000Z
---

Methods allow you to get a list of portal brands or information on a specific brand.

***

::::ExpandableHeading{isOpen="true"}
# <font color="#2166ae">GET</font> /brands

Return a list of brands.

:::ApiMethodV2
```json
{
  "tab": "request",
  "url": "https://instance_name/api/data/v1.0/brands/",
  "name": "Request example",
  "method": "GET",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [
      {
        "kind": "required",
        "name": "Authorization",
        "type": "string",
        "description": "String in \"Token XXXXXX...\" format."
      }
    ],
    "bodyDataParameters": [
      {
        "kind": "optional",
        "name": "limit",
        "type": "Integer",
        "description": "The number of results to return per page."
      },
      {
        "kind": "optional",
        "name": "offset",
        "type": "Integer",
        "description": "The initial index from which to return the results."
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "FJ3zsBaijz6TuVFI40xNy",
        "code": "{\n   \"count\":100,\n   \"next\":\"https://test.eyrene.com/api/data/v1.0/brands/?limit=30&offset=30\",\n   \"previous\":null,\n   \"results\":[\n      {\n         \"id\":31,\n         \"name\":\"ALPEN GOLD\"\n      },\n      {\n         \"id\":32,\n         \"name\":\"BONVIDA\"\n      },\n      {\n         \"id\":33,\n         \"name\":\"BUSHIDO\"\n      },\n      {\n         \"id\":34,\n         \"name\":\"CARTE NOIRE\"\n      },\n      {\n         \"id\":35,\n         \"name\":\"DAVIDOFF COFFEE\"\n      },\n      {\n         \"id\":36,\n         \"name\":\"DIROL\"\n      },\n      {\n         \"id\":37,\n         \"name\":\"DOLCE ALBERO\"\n      }\"...\"\n   ]\n}",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "FJ3zsBaijz6TuVFI40xNy"
  },
  "examples": {
    "languages": [
      {
        "id": "dpmODah_ZAOTKtuSexN5X",
        "code": "curl –i –X GET\n  https://test.eyrene.com/api/data/v1.0/brands/\n  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ \n  –F \"limit=30\" \\\n  –F \"offset=30\" ",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "dpmODah_ZAOTKtuSexN5X"
  },
  "description": "GET /brands",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "autoGeneratedAnchorSlug": "request-example",
  "legacyHash": "qMenX9Hzb1SNOOJMwSl3h"
}
```
:::

## Response parameters[​](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1/agents/agents_list#response-definitions)

***

**`count`** *integer*

The number of brands.

***

**`next`** *string (uri)* <font color="#2166ae">Nullable</font>

Next page.

***

**`previous`** *string (uri)* <font color="#2166ae">Nullable</font>

Previous page.

***

**`results`** *array of objects*

An array of objects with information about brands.

- **`id`** *integer*
  Brand ID.
- **`name`** *string* <font color="#2166ae">\[ 1 .. 255 \] characters</font>
  Brand name.

***


::::

***

::::ExpandableHeading{isOpen="true"}
# <font color="#2166ae">GET</font> /brands/&#x7B;id}

Return information about the brand by ID.

:::ApiMethodV2
```json
{
  "tab": "request",
  "url": "https://instance_name/api/data/v1.0/brand/{id}",
  "name": "Request example",
  "method": "GET",
  "request": {
    "pathParameters": [
      {
        "kind": "required",
        "name": "id",
        "type": "string",
        "description": "Brand ID."
      }
    ],
    "queryParameters": [],
    "headerParameters": [
      {
        "kind": "required",
        "name": "Authorization",
        "type": "string",
        "description": "String in \"Token XXXXXX...\" format."
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "FJ3zsBaijz6TuVFI40xNy",
        "code": "{\n   \"id\":19765,\n   \"name\":\"BUSHIDO\"\n}",
        "language": "200",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "FJ3zsBaijz6TuVFI40xNy"
  },
  "examples": {
    "languages": [
      {
        "id": "dpmODah_ZAOTKtuSexN5X",
        "code": "curl –i –X GET\n  https://test.eyrene.com/api/data/v1.0/brands/19765/\n  -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ \n  –F \"limit=3\" \\\n  –F \"offset=0\" ",
        "language": "curl",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "dpmODah_ZAOTKtuSexN5X"
  },
  "description": "GET /brand/{id}",
  "currentNewParameter": {
    "label": "Path Parameter",
    "value": "pathParameters"
  },
  "autoGeneratedAnchorSlug": "request-example-1",
  "legacyHash": "Sl1Qrl3p05OurE-ZbZeB6"
}
```
:::

## Response parameters[​](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1/agents/agents_read#response-definitions)

***

**`id`** *integer*

Brand ID.

***

**`name`** *string* <font color="#2166ae">\[ 1 .. 255 \] characters</font>

Brand name.

***
::::

***