White Label Admin - Get all organizations within a white label

White label admin only API to get the list of all organizations.

GET /api/organizations/{organizationId}/whitelabel/organizations

Try it

White Label Admin - Get all organizations within a white label

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations \
  --header 'x-api-key: <api-key>'

200

{
  "success": true,
  "total": 123,
  "organizations": [
    {
      "id": 1,
      "name": "Edge Impulse Inc.",
      "created": "2019-08-31T17:32:28Z",
      "privateProjectCount": 123,
      "logo": "<string>",
      "readme": "<string>",
      "experiments": [
        "<string>"
      ],
      "domain": "<string>",
      "whitelabelId": 123,
      "billable": true,
      "entitlementLimits": {
        "totalStorage": 123,
        "computeTimePerYear": 123,
        "gpuComputeTimePerYear": 123,
        "numberOfProjects": 123,
        "numberOfUsers": 123
      }
    }
  ],
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

Query Parameters

active · integer

Whether to search for entities (users, orgs) active in the last X days

includeDeleted · boolean

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

sort · string

Fields and order to sort query by Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example:

"id,-name"

filters · string

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example:

"billable:true"

limit · integer

Maximum number of results

offset · integer

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

search · string

Search query

Example:

"<id> <name>"

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

total · integer · required

organizations · object[] · required

Array with organizations

Show child attributes

organizations. id · integer · required

Example:

1

organizations. name · string · required

Example:

"Edge Impulse Inc."

organizations. created · string<date-time> · required

Example:

"2019-08-31T17:32:28Z"

organizations. privateProjectCount · integer · required

organizations. logo · string

organizations. readme · string

organizations. experiments · string[]

organizations. domain · string

organizations. whitelabelId · integer

organizations. billable · boolean

organizations. entitlementLimits · object

Show child attributes

organizations.entitlementLimits. totalStorage · number

Storage entitlement, in bytes

organizations.entitlementLimits. computeTimePerYear · number

Total compute time entitlement (CPU + GPU), in seconds

organizations.entitlementLimits. gpuComputeTimePerYear · number

GPU compute time entitlement, in seconds

organizations.entitlementLimits. numberOfProjects · integer

Number of projects allowed for this organization

organizations.entitlementLimits. numberOfUsers · integer

Number of users allowed for this organization

error · string

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