White Label Admin - Get all organizations within a white label

White Label Admin - Get all organizations within a white label

get

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerRequired

Organization ID

Query parameters

activeintegerOptional

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

includeDeletedbooleanOptional

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

sortstringOptional

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

filtersstringOptional

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

Example: billable:true

limitintegerOptional

Maximum number of results

offsetintegerOptional

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

searchstringOptional

Search query

Example: <id> <name>

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/api/organizations/{organizationId}/whitelabel/organizations HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

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