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

# White Label Admin - Get a white label user

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

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}`
- 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/users/:userId/get.ts> (a function with typed inputs; its response is checked against the schema)

White label admin only API to get information about a user.

## Path parameters

- `organizationId` integer, required
- `userId` integer, required

## Response `200`

OK

- AdminGetUserResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `user` AdminApiUser, required
    - `id` integer, required
    - `username` string, required
    - `name` string, required
    - `email` string, required
    - `photo` string
    - `created` string, date-time, required
    - `lastSeen` string, date-time
    - `staffInfo` StaffInfo, required
      - `isStaff` boolean, required
      - `hasSudoRights` boolean, required
      - `companyName` string
    - `pending` boolean, required
    - `jobTitle` string
    - `permissions` Permission[]: List of permissions the user has
    - `companyName` string
    - `activated` boolean, required: Whether the user has activated their account or not.
    - `mfaConfigured` boolean, required: Whether the user has configured multi-factor authentication
    - `stripeCustomerId` string: Stripe customer ID, if any.
    - `hasPendingPayments` boolean: Whether the user has pending payments.
    - `tier` 'free' | 'community-plus' | 'professional' | 'enterprise', required: The user account tier.
    - `idps` string[]: List of identity providers (e.g. Google, GitHub) that the user has used to sign in with
    - `organizations` UserOrganization[], required: Organizations that the user is a member of. Only filled when requesting information about yourself.
      - `id` integer, required
      - `name` string, required
      - `logo` string
      - `isDeveloperProfile` boolean, required
      - `extensionSettings` UserOrganizationExtensionSettings
        - `extensionsAllowMembers` boolean: Whether organization members may create extensions.
        - `extensionsAllowLocalhost` boolean: Whether localhost extension development is enabled for this organization.
        - `extensionsAllowedDomains` string[]: Domains allowed for organization extensions, including enterprise localhost ports.
      - `whitelabelId` integer, nullable, required: Unique identifier of the white label this project belongs to, if any.
      - `isAdmin` boolean, required: Whether the user is admin of this organization or not.
      - `created` string, date-time, required: When the organization was created.
      - `trialId` number, nullable, required: Unique identifier of the trial this organization belongs to, if any.
      - `trialExpiredDate` string, date-time, nullable, required: Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.
      - `trialUpgradedDate` string, date-time, nullable, required: Date when the trial was upgraded to a full enterprise account, if any.
      - `entitlementLimits` EntitlementLimits, required
        - `totalStorage` number: Storage entitlement, in bytes
        - `computeTimePerYear` number: Total compute time entitlement (CPU + GPU), in seconds
        - `gpuComputeTimePerYear` number: GPU compute time entitlement, in seconds
        - `numberOfProjects` integer: Number of projects allowed for this organization
        - `numberOfUsers` integer: Number of users allowed for this organization
      - `userCount` integer, required: The total number of users that are a member of this organization.
      - `adminCount` integer, required: The number of admin users for this organization.
      - `privateProjectCount` integer, required: The number of private projects for this organization.
      - `lastAccessed` string, date-time: Last time this user accessed this organization.
      - `publicProjectLicense` object, required: Default license for new public projects under this organization.
        - `name` string, required
        - `link` string, required
    - `projects` Project[], required
      - `id` integer, required
      - `name` string, required
      - `description` string, required
      - `created` string, date-time, required
      - `owner` string, required: User or organization that owns the project
      - `lastAccessed` string, date-time
      - `lastModified` string, date-time
      - `lastModificationDetails` string: Details about the last modification
      - `logo` string: Custom logo for this project (not available for all projects)
      - `ownerUserId` integer
      - `ownerOrganizationId` integer
      - `ownerAvatar` string: URL of the project owner avatar, if any.
      - `ownerIsDeveloperProfile` boolean, required
      - `developerProfileUserId` integer: User ID of the developer profile, if any.
      - `collaborators` ProjectCollaborator[], required
        - `id` integer, required
        - `username` string, required
        - `name` string, required
        - `email` string, required
        - `photo` string
        - `created` string, date-time, required
        - `lastSeen` string, date-time
        - `staffInfo` StaffInfo, required
          - `isStaff` boolean, required
          - `hasSudoRights` boolean, required
          - `companyName` string
        - `pending` boolean, required
        - `jobTitle` string
        - `permissions` Permission[]: List of permissions the user has
        - `companyName` string
        - `activated` boolean, required: Whether the user has activated their account or not.
        - `mfaConfigured` boolean, required: Whether the user has configured multi-factor authentication
        - `stripeCustomerId` string: Stripe customer ID, if any.
        - `hasPendingPayments` boolean: Whether the user has pending payments.
        - `tier` 'free' | 'community-plus' | 'professional' | 'enterprise': The user account tier.
        - `idps` string[]: List of identity providers (e.g. Google, GitHub) that the user has used to sign in with
        - `isOwner` boolean, required
      - `labelingMethod` 'single_label' | 'object_detection' | 'label_map', required
      - `metadata` object, required: Metadata about the project
      - `dataExplorerScreenshot` string
      - `isEnterpriseProject` boolean, required: Whether this is an enterprise project
      - `whitelabelId` integer, nullable, required: Unique identifier of the white label this project belongs to, if any.
      - `whitelabelName` string: Name of the white label this project belongs to, if any.
      - `tags` string[]: List of project tags
      - `category` 'Accelerometer' | 'Audio' | 'Images' | 'Keyword spotting' | 'Object detection' | 'Other': Project category
      - `license` 'Apache-2.0' | 'BSD-3-Clause' | 'BSD-3-Clause-Clear'
      - `tier` 'free' | 'community-plus' | 'professional' | 'enterprise', required: The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
      - `hasPublicVersion` boolean, required: Whether this project has been published or not.
      - `isPublic` boolean, required: Whether this is a public version of a project. A version is a snapshot of a project at a certain point in time, which can be used to periodically save the state of a project. Versions can be private (just for internal use and reference) or public, available to everyone. A public version can be cloned by anyone, restoring the state of the project at the time into a new, separate project.
      - `allowsLivePublicAccess` boolean, required: Whether this project allows live, public access. Unlike a public version, a live public project is not fixed in time, and always includes the latest project changes. Similar to public versions, a live public project can be cloned by anyone, creating a new, separate project.
      - `indPauseProcessingSamples` boolean, required
      - `publicProjectListed` boolean, required: If the project allows public access, whether to list it the public projects overview response. If not listed, the project is still accessible via direct link. If the project does not allow public access, this field has no effect.
      - `deletedDate` string, date-time
      - `fullDeletionDate` string, date-time
      - `scheduledFullDeletionDate` string, date-time
    - `experiments` UserExperiment[], required: Experiments the user has access to. Enabling experiments can only be done through a JWT token.
      - `type` string, required
      - `title` string, required
      - `help` string
      - `enabled` boolean, required
      - `showToUser` boolean, required
    - `evaluation` boolean: Whether this is an ephemeral evaluation account.
    - `ambassador` boolean: Whether this user is an ambassador.
    - `suspended` boolean, required: Whether the user is suspended.
    - `trials` EnterpriseTrial[], required: Current or past enterprise trials.
      - `id` integer, required: Unique identifier of the trial.
      - `userId` integer, required: ID of the user who created the trial.
      - `organizationId` integer, required: ID of the organization created for the trial.
      - `created` string, date-time, required: Date when the trial was created. Trials start immediately on creation.
      - `expirationDate` string, date-time, required: Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully deleting the trial organization. This field is ignored if the trial is requested by a non-admin user, defaulting to 14 days trial.
      - `notes` string: Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.
      - `expiredDate` string, date-time, nullable, required: Date when the trial actually expired. This is set when the trial is expired by the system.
      - `deletedDate` string, date-time, nullable, required: Date when the trial was deleted. This is set when the trial is fully deleted by the system.
      - `upgradedDate` string, date-time, nullable, required: Date when the trial was upgraded to a full enterprise account.
    - `dailyMetrics` DailyMetricsRecord[], nullable: Metrics for the last 365 days
      - `date` string, date-time, required: Date of the metrics record.
      - `totalUsers` integer, required: Total number of users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.
      - `totalStaffUsers` integer, required: Total number of staff users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.
      - `totalProjects` integer, required: Total number of projects at the end of the metrics record date.
      - `totalCurrentContractCpuComputeTimeSeconds` integer, required: Total CPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.
      - `totalCurrentContractGpuComputeTimeSeconds` integer, required: Total GPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.
      - `totalCurrentContractComputeTimeSeconds` integer, required: Total compute time since contract start date, or organization / user creation date, at the end of the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.
      - `computeTimeCalculatedSince` string, date-time, required: Date from which the total compute time is calculated. This is the contract start date for billing organizations, or organization / user creation date.
      - `totalStorageSizeBytes` integer, required: Total storage size in bytes at the end of the metrics record date.
      - `usersAdded` integer, required: Number of users added during the metrics record date.
      - `staffUsersAdded` integer: Number of staff users added during the metrics record date.
      - `usersDeleted` integer, required: Number of users deleted during the metrics record date.
      - `staffUsersDeleted` integer: Number of staff users deleted during the metrics record date.
      - `projectsAdded` integer, required: Number of projects added during the metrics record date.
      - `projectsDeleted` integer, required: Number of projects deleted during the metrics record date.
      - `cpuComputeTimeSeconds` integer, required: Total CPU compute time during the metrics record date.
      - `gpuComputeTimeSeconds` integer, required: Total GPU compute time during the metrics record date.
      - `computeTimeSeconds` integer, required: Total compute time during the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.
      - `storageBytesAdded` integer, required: Total storage size in bytes added during the metrics record date.
      - `storageBytesDeleted` integer, required: Total storage size in bytes deleted during the metrics record date.

---

[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)