Get brand links

Gets brand links by the given domain id.

get

We will get the domain from the request or from BrandUrl header request to filter the domain links.

Path parameters

domainIdstringRequired

This is the domain id to filter.

Query parameters

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

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

401

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

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/domains/{domainId}/links HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: 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": []
}