Retrieve a list of users in an application

You can retrieve a list of all or certain users in your Sendbird application using an ApplicationUserListQuery instance. The next() method returns a list of User objects which contain information on users within the application.

JavaScriptTypeScript

// const sb = SendbirdChat.init(...); // For Sendbird Chat SDK initialization details, refer to:
// https://sendbird.com/docs/chat/sdk/v4/javascript/getting-started/send-first-message#2-get-started-3-step-2-initialize-sendbird-chat-sdk

const queryParams = {
    limit: 20
};
const query = sb.createApplicationUserListQuery(queryParams);

const users = await query.next();

ApplicationUserListQuery

Using a number of different parameters the ApplicationUserListQuery instance provides, you can retrieve a list of specific users that match the set values in the parameters. Currently the ApplicationUserListQuery instance supports the following parameters.

List of parameters

Parameter name	Type	Description
userIdsFilter	string[]	Specifies the unique IDs of users you want to retrieve in the filter.
metaDataKeyFilter	string	Specifies a metadata key to retrieve users with metadata containing an item with the specified key and values. Both `metaDataKeyFilter` and `metaDataValuesFilter` must be specified.
metaDataValuesFilter	string[]	Specifies the metadata values to retrieve users with metadata containing an item with the specified key and values. Both `metaDataKeyFilter` and `metaDataValuesFilter` must be specified.
nicknameStartsWithFilter	string	Specifies user nicknames to retrieve users whose nicknames start with the specified value.
limit	number	Specifies the number of users to return per page. (Default: `20`)

Note: We recommend you set the maximum number of user IDs to 250 in the UserID filter. If exceeded, your query may receive an HTTP 414 error indicating that the submitted request data is longer than the Sendbird server is willing to interpret.

JavaScriptTypeScript

// Retrieve certain users using the userIdsFilter parameter.
const queryParams = {
    userIdsFilter: ['Harry', 'Jay', 'Jin'],
};
const query = sb.createApplicationUserListQuery(queryParams);

const users = await query.next();

// Retrieve certain users using the metaDataKeyFilter and metaDataValuesFilter parameters.
const queryParams = {
    metaDataKeyFilter: 'hobby',
    metaDataValuesFilter: ['movie', 'book', 'exercise'],
};
const query = sb.createApplicationUserListQuery(queryParams);

const users = await query.next();

// Retrieve certain users using the nicknameStartsWithFilter parameter.
const queryParams = {
    nicknameStartsWithFilter: 'Ja',
};
const query = sb.createApplicationUserListQuery(queryParams);

const users = await query.next();

On this page

ApplicationUserListQuery

Sample app