---
title: "White Label Admin - Get all white label users"
method: GET
path: "/api/organizations/{organizationId}/whitelabel/users"
tags: ["Organizations"]
---

# White Label Admin - Get all white label users

`GET /api/organizations/{organizationId}/whitelabel/users`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/whitelabel/users/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `organizationId` integer, required

## Query parameters

- `active` integer
- `tier` 'free' | 'community-plus' | 'professional' | 'enterprise': The user account tier.
- `fields` string
- `sort` string: Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending
- `filters` string: Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.
- `limit` integer
- `offset` integer
- `search` string

## Response `200`

OK

- AdminGetUsersResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `total` integer, required
  - `users` object[], required
    - `id` integer, required
    - `username` string, required
    - `email` string, required
    - `name` string, required
    - `photo` string
    - `created` string, date-time, required
    - `lastSeen` string, date-time
    - `activated` boolean
    - `from_evaluation` boolean
    - `tier` 'free' | 'community-plus' | 'professional' | 'enterprise': The user account tier.
    - `deletedDate` string, date-time

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)