Get brand links by type

Gets brand links by type.

get

Path parameters

domainIdstringRequired

The id of the domain.

typestring · enumRequired

The type of the brand link.

Possible values:

Query parameters

namestringOptional

The name query parameter to filter.

isReplaceTemplatebooleanOptional

The flag to replace the template. If true, the template will be replaced with the brand link and return the result.

Default: true

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

401

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

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/domains/{domainId}/links/load-type/{type} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "brandId": "KAOplmx0i1A",
      "parentBrandLinkId": "Plo0szlmPs",
      "name": "Name",
      "type": "BodyFooter",
      "styles": "Group Name",
      "iconURL": "https://www.example.com/icon.png",
      "link": "https://www.example.com",
      "description": "Description",
      "status": "Active",
      "items": [],
      "zOrder": 1,
      "id": "sApKpllz4sAplsmzha"
    }
  ],
  "errors": []
}