Get Users

Get Users.

A contact (user) is a person in your project's membership directory, with one or more linked logins (identities). Membership manages their profile, identities, roles, and lifecycle. This method returns the users defined in your project.

This method is on the runtime API surface (norbix.api.membership) — call it from your app.

These examples assume the SDK is installed and your credentials are set as environment variables — each client reads them automatically, so the constructors below take no arguments. See Install a Norbix SDK.

JavaScript / TypeScript

import { Norbix } from '@norbix.ai/ts';
const norbix = new Norbix();

const result = await norbix.api.membership.getUsers({
  includePermissions: true,
  userShouldHavePushDevice: true,
  userShouldHaveEmail: true,
  includeMeta: true,
});

.NET

using Norbix.Sdk;
using Norbix.Sdk.Types.Api;

using var client = new NorbixClient();

var result = await client.Membership.GetUsersAsync(new GetUsersRequest
{
    IncludePermissions = true,
    UserShouldHavePushDevice = true,
    UserShouldHaveEmail = true,
    IncludeMeta = true,
});

Python

from norbix_python import NorbixApi

norbix = NorbixApi()

result = norbix.membership.get_users(
    includePermissions=True,
    userShouldHavePushDevice=True,
    userShouldHaveEmail=True,
    includeMeta=True,
)

Go

c, _ := norbix.New(norbix.Options{})
ctx := context.Background()

var result map[string]any
err := c.API.Membership.GetUsers(ctx, map[string]any{
	"includePermissions": true,
	"userShouldHavePushDevice": true,
	"userShouldHaveEmail": true,
	"includeMeta": true,
}, &result)

Dart / Flutter

import 'package:norbix/norbix_api.dart';

final api = NorbixApi();

final result = await api.membership.getUsers(body: {
  'includePermissions': true,
  'userShouldHavePushDevice': true,
  'userShouldHaveEmail': true,
  'includeMeta': true,
});

Swift

import NorbixSwift

let client = Norbix()

let result = try await client.api.membership.getUsers([
    "includePermissions": true,
    "userShouldHavePushDevice": true,
    "userShouldHaveEmail": true,
    "includeMeta": true,
])

Kotlin

import dev.norbix.sdk.api.NorbixApi

val api = NorbixApi()

val result = api.membership.getUsers(mapOf(
    "includePermissions" to true,
    "userShouldHavePushDevice" to true,
    "userShouldHaveEmail" to true,
    "includeMeta" to true,
))

CLI

norbix users list

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Users.

API reference

Full request and response for this endpoint: Get Users.