White Label Admin - Get organization information

White Label Admin - Get organization information

White label admin only API to list all information about an organization.

get

/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

innerOrganizationIdintegerrequired

Organization ID within the context of a white label

Query parameters

includeDeletedboolean

Whether to include deleted entities (users, projects, orgs)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "success": true,
  "error": "text",
  "cpuComputeTime": 1,
  "gpuComputeTime": 1,
  "totalComputeTime": 1,
  "billable": true,
  "entitlementLimits": {
    "totalStorage": 1,
    "computeTimePerYear": 1,
    "gpuComputeTimePerYear": 1,
    "numberOfProjects": 1,
    "numberOfUsers": 1
  },
  "computeTimeCurrentContractSince": "2025-02-21T18:03:17.719Z",
  "totalStorage": 1,
  "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
    }
  ]
}

OK