Skip to main content
GET
/
api
/
organizations
/
{organizationId}
/
whitelabel
/
organizations
/
{innerOrganizationId}
White Label Admin - Get organization information
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "cpuComputeTime": 123,
  "gpuComputeTime": 123,
  "totalComputeTime": 123,
  "billable": true,
  "entitlementLimits": {
    "totalStorage": 123,
    "computeTimePerYear": 123,
    "gpuComputeTimePerYear": 123,
    "numberOfProjects": 123,
    "numberOfUsers": 123
  },
  "computeTimeCurrentContractSince": "2023-11-07T05:31:56Z",
  "totalStorage": 123,
  "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
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

innerOrganizationId
integer
required

Organization ID within the context of a white label

Query Parameters

includeDeleted
boolean

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

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

error
string

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

cpuComputeTime
number

CPU compute time in seconds of all jobs in the organization (including organizational project jobs).

gpuComputeTime
number

GPU compute time in seconds of all jobs in the organization (including organizational project jobs).

totalComputeTime
number

Total compute time is the amount of computation time spent in jobs, in minutes used by an organization over the given period, calculated as CPU + GPU minutes.

billable
boolean
entitlementLimits
object
computeTimeCurrentContractSince
string<date-time>

The date from which the compute time for the running contract is calculated.

totalStorage
number

Total storage used by the organization.

dailyMetrics
object[] | null

Metrics for the last 365 days

I