White Label Admin - Get a white label user

PreviousWhite Label Admin - Get all white label users NextWhite Label Admin - Update white label user

Last updated 10 months ago

Was this helpful?

White Label Admin - Get a white label user

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

get

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

Authorizations

Path parameters

organizationIdintegerrequired

Organization ID

userIdintegerrequired

User ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

{
  "success": true,
  "error": "text",
  "user": {
    "id": 1,
    "username": "janjongboom",
    "name": "Jan Jongboom",
    "email": "text",
    "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
    "created": "2019-08-31T17:32:28Z",
    "lastSeen": "2025-02-21T18:03:23.901Z",
    "staffInfo": {
      "isStaff": true,
      "hasSudoRights": true,
      "companyName": "text"
    },
    "pending": true,
    "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
    "jobTitle": "Software Engineer",
    "companyName": "Edge Impulse Inc.",
    "activated": true,
    "mfaConfigured": true,
    "stripeCustomerId": "text",
    "hasPendingPayments": true,
    "tier": "free",
    "permissions": [
      "admin:infra:disallowedEmailDomains:write"
    ],
    "evaluation": true,
    "ambassador": true,
    "suspended": true,
    "organizations": [
      {
        "id": 1,
        "name": "text",
        "logo": "text",
        "isDeveloperProfile": true,
        "whitelabelId": 1,
        "isAdmin": true,
        "created": "2019-08-31T17:32:28Z",
        "trialId": 1,
        "trialExpiredDate": "2019-08-31T17:32:28Z",
        "trialUpgradedDate": "2019-08-31T17:32:28Z",
        "entitlementLimits": {
          "totalStorage": 1,
          "computeTimePerYear": 1,
          "gpuComputeTimePerYear": 1,
          "numberOfProjects": 1,
          "numberOfUsers": 1
        },
        "userCount": 1,
        "adminCount": 1,
        "privateProjectCount": 1,
        "lastAccessed": "2025-02-21T18:03:23.901Z"
      }
    ],
    "projects": [
      {
        "id": 1,
        "name": "Water hammer detection",
        "description": "text",
        "created": "2019-07-21T17:32:28Z",
        "owner": "text",
        "lastAccessed": "2019-07-21T17:32:28Z",
        "lastModified": "2019-07-21T17:32:28Z",
        "lastModificationDetails": "Data sample added",
        "logo": "text",
        "ownerUserId": 1,
        "ownerOrganizationId": 1,
        "ownerAvatar": "text",
        "ownerIsDeveloperProfile": true,
        "developerProfileUserId": 1,
        "metadata": {},
        "dataExplorerScreenshot": "text",
        "isEnterpriseProject": true,
        "whitelabelId": 1,
        "whitelabelName": "text",
        "category": "Image classification",
        "license": "text",
        "tier": "free",
        "hasPublicVersion": true,
        "isPublic": true,
        "allowsLivePublicAccess": true,
        "indPauseProcessingSamples": true,
        "publicProjectListed": true,
        "deletedDate": "2025-02-21T18:03:23.901Z",
        "fullDeletionDate": "2025-02-21T18:03:23.901Z",
        "scheduledFullDeletionDate": "2025-02-21T18:03:23.901Z",
        "labelingMethod": "single_label",
        "collaborators": [
          {
            "id": 1,
            "username": "janjongboom",
            "name": "Jan Jongboom",
            "email": "quijote@edgeimpulse.com",
            "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
            "created": "2019-08-31T17:32:28Z",
            "lastSeen": "2019-08-31T17:32:28Z",
            "staffInfo": {
              "isStaff": true,
              "hasSudoRights": true,
              "companyName": "text"
            },
            "pending": true,
            "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
            "jobTitle": "Software Engineer",
            "companyName": "Edge Impulse Inc.",
            "activated": true,
            "mfaConfigured": true,
            "stripeCustomerId": "text",
            "hasPendingPayments": true,
            "tier": "free",
            "permissions": [
              "admin:infra:disallowedEmailDomains:write"
            ],
            "isOwner": true
          }
        ],
        "tags": [
          "FOMO",
          "beers"
        ]
      }
    ],
    "experiments": [
      {
        "type": "text",
        "title": "text",
        "help": "text",
        "enabled": true,
        "showToUser": true
      }
    ],
    "trials": [
      {
        "id": 1,
        "userId": 1,
        "organizationId": 1,
        "created": "2025-02-21T18:03:23.901Z",
        "expirationDate": "2020-01-01T00:00:00Z",
        "notes": "This is a trial for the company's new project.",
        "expiredDate": "2025-02-21T18:03:23.901Z",
        "deletedDate": "2025-02-21T18:03:23.901Z",
        "upgradedDate": "2025-02-21T18:03:23.901Z"
      }
    ],
    "dailyMetrics": [
      {
        "date": "2021-01-01T00:00:00Z",
        "totalUsers": 100,
        "totalStaffUsers": 10,
        "totalProjects": 50,
        "totalCurrentContractCpuComputeTimeSeconds": 100000,
        "totalCurrentContractGpuComputeTimeSeconds": 100000,
        "totalCurrentContractComputeTimeSeconds": 100000,
        "computeTimeCalculatedSince": "2021-01-01T00:00:00Z",
        "totalStorageSizeBytes": 1000000000,
        "usersAdded": 10,
        "staffUsersAdded": 1,
        "usersDeleted": 5,
        "staffUsersDeleted": 1,
        "projectsAdded": 10,
        "projectsDeleted": 5,
        "cpuComputeTimeSeconds": 10000,
        "gpuComputeTimeSeconds": 10000,
        "computeTimeSeconds": 10000,
        "storageBytesAdded": 1000000000,
        "storageBytesDeleted": 500000000
      }
    ]
  }
}