Organizations

White Label Admin - Get all white label users

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

get/api/organizations/{organizationId}/whitelabel/users

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/users/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Query parameters

activeinteger

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

tier'free' | 'community-plus' | 'professional' | 'enterprise'

The user account tier.

Whether to search for free, community plus, professional, or enterprise entities (users, projects)

fieldsstring

Example:id,name

Comma separated list of fields to fetch in a query

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

Response

successboolean required

Whether the operation succeeded

errorstring

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

totalinteger required

Example response

{
  "users": [
    {
      "id": 1,
      "username": "janjongboom",
      "email": "jan@edgeimpulse.com",
      "name": "Jan Jongboom",
      "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
      "created": "2019-08-31T17:32:28Z",
      "lastSeen": "2019-08-31T17:32:28Z",
      "deletedDate": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

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