Find Users

Finds Users matching your criteria. The Users.Find method supports a fluent style where you can chain together your search criteria.

Method Signature

find(): Promise<UsersPage>;
find(options: FindUsersOptions): Promise<UsersPage>;
find(callback: (err?: Error, usersPage: UsersPage) => any): void;
find(options: FindUsersOptions, callback: (err?: Error, usersPage: UsersPage) => any): void;


optionsFindUsersOptionsOptional The paging options filter criteria to search by, or null to fetch all Users.
options.querystringOptional A query string to search by. Applies to the name property of Users
options.pageSizenumberOptional The number of Users to fetch in a single UsersPage response25
options.pageTokenstringOptional The nextPageToken of a previous find request, used to fetch the next set of results
callback(err?: Error, usersPage: UsersPage) => anyOptional The callback
returnsUsersPageThe requested page of Users


 * This example demonstrates listing all users
const { CatalyticClient } = require('@catalytic/sdk');

const catalytic = new CatalyticClient();

const users = [];

const options = { pageSize: 25 };
let hasNextPage = true;

while (hasNextPage) {
    const usersPage = await catalytic.users.find(options);
    if (usersPage.nextPageToken) {
        options.pageToken = usersPage.nextPageToken;
    } else {
        hasNextPage = false;

users.forEach(user => {