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

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

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.

Options: free, community-plus, professional, enterprise

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "total": 1,
  "users": [
    {
      "id": 1,
      "username": "janjongboom",
      "email": "[e-mail]",
      "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"
    }
  ]
}

OK