List Brands

GET 
/brand

This endpoint is used to list all brands associated with your organization.

Request

Query Parameters

page Page

Possible values: >= 1

Default value: 1

recordsPerPage Recordsperpage

Default value: 10

number of records per page. maximum of 500

displayName Displayname
entityType Entitytype
state State
country Country

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

records

object[]

Array [

brandId string

Unique identifier assigned to the brand.

tcrBrandId string

Unique identifier assigned to the brand by the registry.

entityType EntityType (string)

Possible values: [PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT]

Entity type behind the brand. This is the form of business establishment.

companyName string

(Required for Non-profit/private/public) Legal company name.

displayName string

Display or marketing name of the brand.

email string

Valid email address of brand support contact.

website string

Brand website URL.

createAt string

Date and time that the brand was created at.

updatedAt string

Date and time that the brand was last updated at.

]

page Page (integer)
totalRecords Totalrecords (integer)

{
  "records": [
    {
      "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
      "tcrBrandId": "BBRAND1",
      "entityType": "PRIVATE_PROFIT",
      "companyName": "Example Company Inc.",
      "displayName": "Example Company",
      "email": "[email protected]",
      "website": "www.examplecompany.com",
      "createAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186"
    }
  ],
  "page": 1,
  "totalRecords": 1
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...