---
title: "Get brand metadata"
method: GET
path: "/v1/projects/{projectId}/brand-metadata"
tags: ["brands"]
---

# Get brand metadata

`GET /v1/projects/{projectId}/brand-metadata`

Given a brand type in a query param, this endpoint returns the metadata required to build the brand registration form. The metadata is based on different brand categories that contain different set of attributes. Each attribute comes with its own set of validation rules.

## Path parameters

- `projectId` string, required

## Query parameters

- `brandType` 'US_SHORT_CODE_REGISTRY', enum, required

## Response `200`

Successfully retrieved Brand Metadata

- BrandMetadata — The metadata required to build the brand registration form.
  - `brandMetadataId` string — The unique identifier for the brand metadata.
  - `brandType` 'US_SHORT_CODE_REGISTRY', enum
  - `marketCode` string — The market code for the brand metadata type.
  - `majorVersion` integer — The major version of the brand metadata type.
  - `minorVersion` integer — The minor version of the brand metadata type.
  - `createTime` string, date-time — The date and time when the brand metadata was created.
  - `data` BrandMetadataCategory[] — The list of categories included in the brand metadata. Each of them includes a list of attributes.
    - `categoryType` string — Category type
    - `title` string — Title is useful to display the category in the UI.
    - `attributes` BrandMetadataCategoryAttribute[] — The list of attributes included in the category.
      - `description` string — Attribute description. It should be used as a description, hoover or helping text in a UI.
      - `title` string — Title of the attribute that can be used in the UI to request the attribute field.
      - `required` boolean — Indicates whether the attribute is required or not.
      - `type` string — The type of the attribute.
      - `maxLength` integer — Max length of text field
      - `minLength` integer — Min length of text field
      - `name` string — Name of the field. Serves as a key (reference) to a field
      - `pattern` string — Regex pattern validation
      - `message` object — Pattern validation message
        - `pattern` string — Pattern validation message
        - `maxLength` string — Max length of the field value
        - `minLength` string — Min length of the field value
        - `minItems` string — The minimum number of items in the array that must be selected. Used in array types.
      - `items` object — Some attributes can be an array of items. This field is used to define the values the customer can select.
        - `type` string — The type of the attribute. Along with the type, api can provide a set of values under enum property
        - `enum` string[] — The list of possible values for the attribute.
      - `minItems` integer — The minimum number of items in the array that must be selected. Used in array types.
      - `multiline` boolean — Indicates whether the attribute is a multiline text field or not.

## Other responses

- `404` — NOT_FOUND: Brand Metadata type not found
- `500` — INTERNAL: Internal server error. Typically, a server bug.

---

[API](https://skmtc.net/sinch/apis/sinch-brands-api.md) · [All operations](https://skmtc.net/sinch/apis/sinch-brands-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/sinch-brands-api/revisions/b49d3ae283fd/schema)