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

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

The API result model 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: 1Required

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

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/{userId}/connections

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": "2026-01-26T08:03:23.939569+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": []
}