getJoinRequests

Get pending join requests in a chat. USER-ONLY

Parameters

chatId: ID

The identifier of a chat with the join requests.

An invite link. If specified, only join requests from that invite link will be returned.

A search query. If specified, only matching users results will be returned.

fromDate?: Date

A point in time. If specified, results will be fetched from that date.

fromUserId?: ID

A user ID. If specified, results will be fetched from that user.

limit?: number

The maximum number of results to return. Must be in the range of 1-100. Defaults to 100.

Result

JoinRequest[]

Syntax

// Required parameters only.
await client.getJoinRequests(chatId);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.getJoinRequests(chatId, {
    inviteLink,
    search,
    fromDate,
    fromUserId,
    limit,
});