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

White Label Admin - Get all white label users

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "total": 123,
  "users": [
    {
      "id": 1,
      "username": "janjongboom",
      "email": "[e-mail]",
      "name": "Jan Jongboom",
      "created": "2019-08-31T17:32:28Z",
      "photo": "https://usercdn.edgeimpulse.com/photos/1.jpg",
      "lastSeen": "2019-08-31T17:32:28Z",
      "activated": true,
      "from_evaluation": true,
      "deletedDate": "2024-01-01T00:00:00Z"
    }
  ],
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

Query Parameters

active · integer

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

tier · enum<string>

Whether to search for free, community plus, professional, or enterprise entities (users, projects) The user account tier.

Available options: free, community-plus, professional, enterprise

fields · string

Comma separated list of fields to fetch in a query

Example:

"id,name"

sort · string

Fields and order to sort query by 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"

filters · string

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

Example:

"billable:true"

limit · integer

Maximum number of results

offset · integer

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

search · string

Search query

Example:

"<id> <name>"

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

total · integer · required

users · object[] · required

Show child attributes

error · string

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