Retrieves a paginated list of users from your Sendbird application. Use this tool to: - Browse all users in your application - Search for users by nickname or user IDs - Filter users by metadata, custom type, or activity status - Paginate through large user lists using the 'next…
limitintegerMaximum number of users to return per page (1-100). Defaults to 10 if not specified.
orderstringSort order for results. Options: 'nickname_alphabetical' (A-Z by nickname), 'created_at' (newest first), 'user_id_alphabetical' (A-Z by user ID).
tokenstringPagination token from the 'next' field of a previous response. Omit for the first page.
nicknamestringFilter users by exact nickname match (case-insensitive).
user_idsarrayFilter to only return specific users by their IDs. Provide as a list of user ID strings.
is_activebooleanFilter by account status. Set to true for active users, false for deactivated users.
custom_typestringFilter users by their custom type classification.
metatag_keystringFilter users who have this metadata key set. Use with metatag_values for key-value filtering.
metatag_valuesarrayFilter users by metadata values for the specified metatag_key. Requires metatag_key to be set.
nickname_containsstringFilter users whose nickname contains this substring (case-insensitive partial match).
has_ever_logged_inbooleanFilter by login history. Set to true for users who have logged in, false for never logged in.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.