---
title: "White Label Admin - Get white label information"
method: GET
path: "/api/organizations/{organizationId}/whitelabel"
tags: ["Organizations"]
---

# White Label Admin - Get white label information

`GET /api/organizations/{organizationId}/whitelabel`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/whitelabel/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `organizationId` integer, required

## Response `200`

OK

- GetWhitelabelResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `whitelabel` Whitelabel
    - `id` integer, required
    - `name` string, required
    - `domain` string, required
    - `ownerOrganizationId` integer
    - `themeId` integer, required
    - `theme` Theme
      - `id` integer, required
      - `ownerUserId` integer
      - `ownerOrganizationId` integer
      - `name` string, required
      - `favicon` object, required
        - `favicon32` string
        - `favicon57` string
        - `favicon76` string
        - `favicon96` string
        - `favicon120` string
        - `favicon128` string
        - `favicon144` string
        - `favicon152` string
        - `favicon180` string
        - `favicon228` string
      - `logos` object, required
        - `primary` string
        - `primaryPng` string
        - `primaryWhite` string
        - `loginLogo` string
        - `loginLogoWhite` string
        - `mark` string
        - `markWhite` string
        - `deviceLogo` string
      - `colors` object, required
        - `primaryColor` string
        - `primaryColorRgb` number[]
        - `primaryColorGradientEnd` string
    - `identityProviders` string[], required
    - `allowPasswordAuth` boolean, required
    - `deploymentTargets` string[], required: List of deployment targets enabled for this white label
    - `allDeploymentTargets` string[], required: List of all supported deployment targets
    - `customDeploymentBlocks` object[]: List of custom deployment blocks available to this white label
      - `name` string, required: The name of the custom deployment block
      - `id` number, required: The custom deployment block ID
    - `deploymentOptionsOrder` string[]: Optional attribute allowing a whitelabel to customize the order of deployment options in the deployment view, given as an in-order list of deployment options.
    - `allowSignup` boolean, required
    - `allowFreeProjects` boolean, required
    - `exposePublicProjects` boolean
    - `defaultDeploymentTarget` string, nullable: The name of the default deployment target for this white label
    - `supportedProjectTypes` ProjectType[], required
    - `allowNewProjectUi` boolean, required: Whether the new project UI should be enabled for this white label or not.
    - `learningBlocks` string[], required: List of learning blocks enabled for this white label
    - `allLearningBlocks` object[], required: List of all supported learning blocks
      - `title` string, required: The name of the learning block
      - `type` string, required: The learning block type
    - `developmentBoards` DevelopmentBoardResponse[], required
      - `id` integer, required
      - `name` string, required
      - `image` string, required
      - `docsUrl` string, required
    - `allDevelopmentBoards` DevelopmentBoardResponse[], required
      - `id` integer, required
      - `name` string, required
      - `image` string, required
      - `docsUrl` string, required
    - `organizationsLimit` integer: The maximum number of organizations that can be created under this white label.
    - `disablePublicEntities` boolean: Whether public entities (like projects, user profiles, etc.) are disabled for this whitelabel instance.
    - `requireCollaboratorsInWhitelabel` boolean: Whether adding collaborators to projects requires collaborators to already be members of this whitelabel instance.
    - `disableMarketingFeatures` boolean: Whether marketing features (marketing cookies, HubSpot tracking, etc.) are disabled for this whitelabel instance.
    - `disableForumAccess` boolean: Whether forum access is disabled for this whitelabel instance.
    - `customLimits` object: Custom limits for this whitelabel instance.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)