1 of 1

White Label Admin - Get all organizations within a white label

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

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

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

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

includeDeletedboolean

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

sortstring

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"

filtersstring

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

Example: "billable:true"

limitinteger

Maximum number of results

offsetinteger

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

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

total*integer

organizations*array of object

Array with organizations

id*integer

Example: 1

name*string

Example: "Edge Impulse Inc."

logostring

created*string (date-time)

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

readmestring

experimentsarray of string

itemsstring

domainstring

whitelabelIdinteger

billableboolean

privateProjectCount*integer

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

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

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

Request

Response