White Label Admin - Get all white label users

White Label Admin - Get all white label users

get

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

Query parameters

activeintegerOptional

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

tierstring · enumOptional

The user account tier.

Possible values:

fieldsstringOptional

Comma separated list of fields to fetch in a query

Example: id,name

sortstringOptional

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

filtersstringOptional

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

Example: billable:true

limitintegerOptional

Maximum number of results

offsetintegerOptional

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

searchstringOptional

Search query

Example: <id> <name>

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/api/organizations/{organizationId}/whitelabel/users HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

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