Get brands

Get brands by the given filter.

get

Query parameters

CodestringOptional

The code of the brand.

NamestringOptional

The name of the brand.

AbbrstringOptional

The abbreviation of the brand.

DescriptionstringOptional

The description of the brand.

TagsstringOptional

The tags of the brand.

Statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

KeywordsstringOptional

The keywords of the brand.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/brands

HTTPcURLJavaScriptPython

GET /api/v1/brands HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "parentId": "sApKpllz4sAplsmzha",
        "code": "EXA",
        "name": "Example",
        "abbr": "EXA",
        "description": "JFW",
        "tags": "Example, JFW",
        "status": "Inactive",
        "isDefault": false,
        "isSystem": false,
        "profile": {
          "slogan": "Example Slogan",
          "logoURL": "https://www.example.com/logo.png",
          "faviconURL": "https://www.example.com/favicon.ico",
          "primaryColor": "#000000",
          "primaryColorHover": "#000000",
          "secondaryColor": "#000000",
          "tertiaryColor": "#000000"
        },
        "setting": {
          "domainWhiteListURLs": "https://whitelist.example.io",
          "googleAnalyticsAccount": "UA-******-1",
          "reCaptchaKey": "6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy",
          "currencyCode": "EXA",
          "cdnURL": "https://cdn.example.com",
          "cdnFolder": "exam_cdn",
          "passwordPolicyLevel": "Low"
        },
        "domains": []
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 100
  },
  "errors": []
}