White Label Admin - Get all white label users

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

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

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

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

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

fieldsstring

Comma separated list of fields to fetch in a query

Example: "id,name"

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

users*array of object

id*integer

Example: 1

username*string

Example: "janjongboom"

email*string

Example: "jan@edgeimpulse.com"

name*string

Example: "Jan Jongboom"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

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

lastSeenstring (date-time)

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

activatedboolean

from_evaluationboolean

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "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",
      "activated": false,
      "from_evaluation": false,
      "tier": "free"
    }
  ]
}