White Label Admin - Get white label information

White label admin only API to get the white label information.

GET /api/organizations/{organizationId}/whitelabel

White Label Admin - Get white label information

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "error": "<string>",
  "whitelabel": {
    "id": 123,
    "name": "<string>",
    "domain": "<string>",
    "themeId": 123,
    "identityProviders": [
      "<string>"
    ],
    "allowPasswordAuth": true,
    "deploymentTargets": [
      "<string>"
    ],
    "allDeploymentTargets": [
      "<string>"
    ],
    "allowSignup": true,
    "allowFreeProjects": true,
    "supportedProjectTypes": [],
    "allowNewProjectUi": true,
    "learningBlocks": [
      "<string>"
    ],
    "allLearningBlocks": [
      {
        "title": "<string>",
        "type": "<string>"
      }
    ],
    "developmentBoards": [
      {
        "id": 123,
        "name": "<string>",
        "image": "<string>",
        "docsUrl": "<string>"
      }
    ],
    "allDevelopmentBoards": [
      {
        "id": 123,
        "name": "<string>",
        "image": "<string>",
        "docsUrl": "<string>"
      }
    ],
    "ownerOrganizationId": 123,
    "theme": {
      "id": 123,
      "name": "<string>",
      "favicon": {
        "favicon32": "<string>",
        "favicon57": "<string>",
        "favicon76": "<string>",
        "favicon96": "<string>",
        "favicon120": "<string>",
        "favicon128": "<string>",
        "favicon144": "<string>",
        "favicon152": "<string>",
        "favicon180": "<string>",
        "favicon228": "<string>"
      },
      "logos": {
        "primary": "<string>",
        "primaryPng": "<string>",
        "primaryWhite": "<string>",
        "loginLogo": "<string>",
        "loginLogoWhite": "<string>",
        "mark": "<string>",
        "markWhite": "<string>",
        "deviceLogo": "<string>"
      },
      "colors": {
        "primaryColor": "<string>",
        "primaryColorRgb": [
          123
        ],
        "primaryColorGradientEnd": "<string>"
      },
      "ownerUserId": 123,
      "ownerOrganizationId": 123
    },
    "customDeploymentBlocks": [
      {
        "name": "<string>",
        "id": 123
      }
    ],
    "deploymentOptionsOrder": [
      "org-1"
    ],
    "exposePublicProjects": true,
    "defaultDeploymentTarget": "C++ Library",
    "organizationsLimit": 123,
    "disablePublicEntities": true,
    "disableMarketingFeatures": true,
    "disableForumAccess": true,
    "customLimits": {}
  }
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

error · string

Optional error description (set if 'success' was false)

whitelabel · object

Show child attributes