White Label Admin - Get a white label user

White Label Admin - Get a white label user

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

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

user*AdminApiUser (all of)

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "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": "2024-11-21T08:33:52.481Z",
    "staffInfo": {
      "isStaff": false,
      "hasSudoRights": false,
      "companyName": "text"
    },
    "pending": false,
    "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
    "jobTitle": "Software Engineer",
    "permissions": [
      "admin:infra:disallowedEmailDomains:write"
    ],
    "companyName": "Edge Impulse Inc.",
    "activated": false,
    "mfaConfigured": false,
    "stripeCustomerId": "text",
    "hasPendingPayments": false,
    "tier": "free",
    "organizations": [
      {
        "name": "text",
        "logo": "text",
        "isDeveloperProfile": false,
        "isAdmin": false,
        "created": "2019-08-31T17:32:28Z",
        "trialId": 1,
        "trialExpiredDate": "2019-08-31T17:32:28Z",
        "trialUpgradedDate": "2019-08-31T17:32:28Z",
        "entitlementLimits": {
          "totalStorage": 0,
          "computeTimePerYear": 0,
          "gpuComputeTimePerYear": 0
        },
        "lastAccessed": "2024-11-21T08:33:52.481Z"
      }
    ],
    "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",
        "ownerAvatar": "text",
        "ownerIsDeveloperProfile": false,
        "collaborators": [
          {
            "id": 1,
            "username": "janjongboom",
            "name": "Jan Jongboom",
            "email": "[e-mail]",
            "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
            "created": "2019-08-31T17:32:28Z",
            "lastSeen": "2019-08-31T17:32:28Z",
            "staffInfo": {
              "isStaff": false,
              "hasSudoRights": false,
              "companyName": "text"
            },
            "pending": false,
            "lastTosAcceptanceDate": "2019-08-31T17:32:28Z",
            "jobTitle": "Software Engineer",
            "permissions": [
              "admin:infra:disallowedEmailDomains:write"
            ],
            "companyName": "Edge Impulse Inc.",
            "activated": false,
            "mfaConfigured": false,
            "stripeCustomerId": "text",
            "hasPendingPayments": false,
            "tier": "free",
            "isOwner": false
          }
        ],
        "labelingMethod": "single_label",
        "dataExplorerScreenshot": "text",
        "isEnterpriseProject": false,
        "tags": [
          "FOMO",
          "beers"
        ],
        "category": "Image classification",
        "license": "text",
        "tier": "free",
        "hasPublicVersion": false,
        "isPublic": false,
        "allowsLivePublicAccess": false,
        "indPauseProcessingSamples": false,
        "publicProjectListed": false
      }
    ],
    "experiments": [
      {
        "type": "text",
        "title": "text",
        "help": "text",
        "enabled": false,
        "showToUser": false
      }
    ],
    "evaluation": false,
    "ambassador": false,
    "suspended": false,
    "trials": [
      {
        "created": "2024-11-21T08:33:52.481Z",
        "expirationDate": "2020-01-01T00:00:00Z",
        "notes": "This is a trial for the company's new project.",
        "expiredDate": "2024-11-21T08:33:52.481Z",
        "deletedDate": "2024-11-21T08:33:52.481Z",
        "upgradedDate": "2024-11-21T08:33:52.481Z"
      }
    ],
    "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
      }
    ]
  }
}