List all the brand partners authenticate

Gets the connection authenticate brand status.

get

Path parameters

userIdstringRequired

The id of the user to get the connection authenticate brand status for.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

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

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId}/connections HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "status": "Connected",
    "createdDate": "2025-06-23T13:56:00.838512+07:00",
    "brand": {
      "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": []
    }
  },
  "errors": []
}