GET
/
api
/
organizations
/
{organizationId}
/
whitelabel
White Label Admin - Get white label information
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "whitelabel": {
    "id": 123,
    "name": "<string>",
    "domain": "<string>",
    "ownerOrganizationId": 123,
    "themeId": 123,
    "theme": {
      "id": 123,
      "ownerUserId": 123,
      "ownerOrganizationId": 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>"
      }
    },
    "identityProviders": [
      "<string>"
    ],
    "allowPasswordAuth": true,
    "deploymentTargets": [
      "<string>"
    ],
    "allDeploymentTargets": [
      "<string>"
    ],
    "customDeploymentBlocks": [
      {
        "name": "<string>",
        "id": 123
      }
    ],
    "deploymentOptionsOrder": [
      "org-1"
    ],
    "allowSignup": true,
    "allowFreeProjects": true,
    "exposePublicProjects": true,
    "defaultDeploymentTarget": "C++ Library",
    "supportedProjectTypes": [
      "kws"
    ],
    "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>"
      }
    ],
    "organizationsLimit": 123,
    "disablePublicEntities": true
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

Response

200 - application/json

OK

The response is of type object.