Skip to main content

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

Schema

    records

    object[]

  • Array [

  • brandId string

    Unique identifier assigned to the brand.

    entityType EntityType

    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
    totalRecords Totalrecords

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...