DocsDocsReference

Retrieve a brand by ID

Retrieves a single brand and all its associated series by brand ID. Includes brand details, logo, cover image, description, translations, and all series under the brand.

GET/api/v1/{team_slug}/{app_slug}/brands/{brand_id}
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/brands/{brand_id}

Retrieves a single brand and all its associated series by brand ID. Includes brand details, logo, cover image, description, translations, and all series under the brand.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}
  • Summary: Retrieve a brand by ID
  • Description: Retrieves a single brand and all its associated series by brand ID. Includes brand details, logo, cover image, description, translations, and all series under the brand.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
brand_idpathYesstringId of brand
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200Brand returned successfullyapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Brand

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Brand
PropertyTypeRequiredDetails
addressobjectNobrand address
coverobjectNo-
created_atstringNo-
descriptionstringNobrand description
emailstringNobrand email
idstringNounique id of brand
logoobjectNo-
namestringNoname of brand
seriesobject[]Noseries connected to the brand
slugstringNoslug of brand
translationsobjectNo-
updated_atstringNo-
Brand Address
PropertyTypeRequiredDetails
citystringNo-
co_addressstringNo-
countrystringNo-
house_numberstringNo-
postal_codestringNo-
state_provincestringNo-
street_addressstringNo-
Brand Image
PropertyTypeRequiredDetails
idstringNo-
urlstringNo-
Brand Series
PropertyTypeRequiredDetails
idstringNounique id of series
namestringNoname of series
slugstringNoname of series
Brand Translations
PropertyTypeRequiredDetails
descriptionobject[]No-
{
  "data": {
    "address": {
      "city": "string",
      "co_address": "string",
      "country": "string",
      "house_number": "string",
      "postal_code": "string",
      "state_province": "string",
      "street_address": "string"
    },
    "cover": {
      "id": "string",
      "url": "string"
    },
    "created_at": "string",
    "description": "string",
    "email": "string",
    "id": "string",
    "logo": {
      "id": "string",
      "url": "string"
    },
    "name": "string",
    "series": [
      {
        "id": "string",
        "name": "string",
        "slug": "string"
      }
    ],
    "slug": "string",
    "translations": {
      "description": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/brands/\{brand_id\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Brands
  • OpenAPI summary: Retrieve a brand by ID

Retrieve a brand by ID

# Retrieve a brand by ID Retrieves a single brand and all its associated series by brand ID. Includes brand details, logo, cover image, description, translations, and all series under the brand.
GET /api/v1/{team_slug}/{app_slug}/brands/{brand_id}
Purpose

Retrieves a single brand and all its associated series by brand ID.

Required inputs

app_slug path team_slug path brand_id path

Primary response

200 ยท Brand returned successfully

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/brands/{brand_id}

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/brands/{brand_id}` - Summary: Retrieve a brand by ID - Description: Retrieves a single brand and all its associated series by brand ID. Includes brand details, logo, cover image, description, translations, and all series under the brand. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/brands/{brand_id}` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | brand_id | path | Yes | string | Id of brand | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Brand returned successfully | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Brand | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Brand | Property | Type | Required | Details | | --- | --- | --- | --- | | `address` | object | No | brand address | | `cover` | object | No | - | | `created_at` | string | No | - | | `description` | string | No | brand description | | `email` | string | No | brand email | | `id` | string | No | unique id of brand | | `logo` | object | No | - | | `name` | string | No | name of brand | | `series` | object[] | No | series connected to the brand | | `slug` | string | No | slug of brand | | `translations` | object | No | - | | `updated_at` | string | No | - | ##### Brand Address | Property | Type | Required | Details | | --- | --- | --- | --- | | `city` | string | No | - | | `co_address` | string | No | - | | `country` | string | No | - | | `house_number` | string | No | - | | `postal_code` | string | No | - | | `state_province` | string | No | - | | `street_address` | string | No | - | ##### Brand Image | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `url` | string | No | - | ##### Brand Series | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | unique id of series | | `name` | string | No | name of series | | `slug` | string | No | name of series | ##### Brand Translations | Property | Type | Required | Details | | --- | --- | --- | --- | | `description` | object[] | No | - |
Generated example (synthetic) ```json { "data": { "address": { "city": "string", "co_address": "string", "country": "string", "house_number": "string", "postal_code": "string", "state_province": "string", "street_address": "string" }, "cover": { "id": "string", "url": "string" }, "created_at": "string", "description": "string", "email": "string", "id": "string", "logo": { "id": "string", "url": "string" }, "name": "string", "series": [ { "id": "string", "name": "string", "slug": "string" } ], "slug": "string", "translations": { "description": [ { "id": null, "locale": null, "value": null } ] }, "updated_at": "string" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/brands/{brand_id}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/brands/{brand_id}` - OpenAPI tag: Brands - OpenAPI summary: Retrieve a brand by ID