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
get
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-09-19T11:20:20.7028732+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": []
}

Last updated

Was this helpful?