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

Try it

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>'

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,
      "tier": "free",
      "deletedDate": "2024-01-01T00:00:00Z"
    }
  ],
  "error": "<string>"
}

Authorizations

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

users. id · integer · required

Example:

1

users. username · string · required

Example:

"janjongboom"

users. email · string · required

Example:

"[e-mail]"

users. name · string · required

Example:

"Jan Jongboom"

users. created · string<date-time> · required

Example:

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

users. photo · string

Example:

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

users. lastSeen · string<date-time>

Example:

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

users. activated · boolean

users. from_evaluation · boolean

users. tier · enum<string>

The user account tier.

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

users. deletedDate · string<date-time>

Example:

"2024-01-01T00:00:00Z"

error · string

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