Retrieve white label details

Retrieve the details of your white label portal, such as any images used in the portal and the portal's domain address.

Request

path Parameters

whiteLabelDomainAddress

required

string

The domain address of your white label portal.

Example: 4mrvil9g37h0o897e7vq3anv4maey3.net-spi.com

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/white-label-information/{whiteLabelDomainAddress}

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api-prod.surfsight.net/v2/white-label-information/:whiteLabelDomainAddress

Response samples

application/json

{"data": {"whiteLabelName": "Fast Fleets Inc.",
"whiteLabelDomainAddress": "login.fast-fleets.com",
"whiteLabellogoUrl": "https://whitelabel.s3.us-east-2.amazonaws.com/fastfleets/logo.png",
"whiteLabelDesktopPictureUrl": "https://whitelabel.s3.us-east-2.amazonaws.com/fastfleets/desktop.png",
"whiteLabelIpadPictureUrl": "https://whitelabel.s3.us-east-2.amazonaws.com/fastfleets/tablet.png",
"whiteLabelMobilePictureUrl": "https://whitelabel.s3.us-east-2.amazonaws.com/fastfleets/phone.png",
"whiteLabelPrivacyPolicyUrl": "https://surfsight.net/privacy_policy/",
"whiteLabelEulaUrl": "https://surfsight.com/eula",
"whiteLabelFaviconUrl": "https://whitelabel.s3.us-east-2.amazonaws.com/fastfleets/favicon.png",
"whiteLabelInfoEmail": "support@fast-fleets.com",
"whiteLabelThemeName": "red",
"whiteLabelThemeColor": "#f44336"
},
"requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}