Get links by type

Gets links by type.

get

Path parameters

idstringRequired

The id of the brand.

typestring · enumRequired

The type of the link.

Possible values:

Query parameters

namestringOptional

The name query parameter to filter.

api-versionstringOptional

Header parameters

BrandUrlstringRequired

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 AuthKey header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/brands/{id}/links/load-type/{type} HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: 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": []
}