Find Users

Suggest Edits

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;

Parameters

Parameter	Type	Description	Default
`options`	`FindUsersOptions`	Optional The paging options filter criteria to search by, or null to fetch all Users.
`options.query`	`string`	Optional A query string to search by. Applies to the `name` property of Users
`options.pageSize`	`number`	Optional The number of Users to fetch in a single `UsersPage` response	`25`
`options.pageToken`	`string`	Optional The `nextPageToken` of a previous `find` request, used to fetch the next set of results
`callback`	`(err?: Error, usersPage: UsersPage) => any`	Optional The callback
returns	`UsersPage`	The requested page of Users

Example

/*
 * 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);
    users.push(...usersPage.users);
    if (usersPage.nextPageToken) {
        options.pageToken = usersPage.nextPageToken;
    } else {
        hasNextPage = false;
    }
}

users.forEach(user => {
    console.log(user.email);
});

Updated over 3 years ago