Organizations

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/whitelabel/organizations/get.ts
A function with typed inputs. Its response is checked against the schema.

organizationIdinteger required

Organization ID

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

Fields and order to sort query by

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

Example:<id> <name>

Search query

successboolean required

Whether the operation succeeded

errorstring

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

totalinteger required

{
  "organizations": [
    {
      "id": 1,
      "name": "Edge Impulse Inc.",
      "created": "2019-08-31T17:32:28Z"
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.