getWhitelistUsers

This method is used to retrieve the list of whitelisted users for app signup.

Field	Type	Required	Description
`method`	String	Yes	`"getWhitelistUsers"`
`app_id`	String	Yes	Unique identifier for the App to which the user belongs.
`reference`	String	Yes	A unique reference for the request (used for tracking or logging).
`page_size`	Number	Optional	Number of users to retrieve per page (default is 50).
`page_number`	Number	Yes	The page number to retrieve in pagination. Start from `0`

Preconditions for API Functionality

The following tables outline the preconditions that must be met for the API to function correctly. Failure to meet these conditions may result in errors or unexpected behavior.

Preconditions for API permissions

Before performing signup management messages, ensure the following conditions are met:

Action	Required Permission	Description
signup Management	`"Signup Management"`	The API must have the `"Signup Management"` permission to manage both whitelist and blacklist settings.

Preconditions for Web Admin of Your App

Before performing signup whitelist management messages, ensure the following conditions are met:

Action	Description
Enable "User Whitelist"	Activate the "Use Whitelist" flag from Web Admin/Signup Settings/Signup Filter to enforce whitelist filtering.

Response

getWhitelistUsersResponse

✅ On success, the getWhitelistUsersResponse method is returned.

Field	Type	Returned	Description
`method`	String	Yes	`"getWhitelistUserResponse"`
`app_id`	String	Yes	Unique identifier for App.
`signups`	Array of signup	Yes	Array of Whitelist signup objects
`page_number`	Number	Optional	The page number to retrieve in pagination. Returns the next page of results.
`eop`	Boolean	Conditional	End of page: Indicates that the last page has been reached. Returns `true` when there are no more pages to retrieve. Default is `false`
`reference`	String	Optional	Unique identifier echoed from the request.

Requests

json
{
  "method": "getWhitelistUsers",
  "app_id": "90090684293000559",
  "reference": 111111148
}

java

api.getWhiteList(incomingMsg.getChat().getId());

public void getWhiteList(String chatId) {
	GetWhiteListOutMessage getWhiteListOutMessage = new GetWhiteListOutMessage();
	getWhiteListOutMessage.setChatId(chatId);
	api.send(getWhiteListOutMessage);
}

javascript

api.getWhiteList(chat.id);

Response

json

  
    "method": "getWhitelistUsersResponse",
    "app_id": "90090684293000559",
    "signups": [
            {
                "id": "490",
                "signup_id": "example@email.com",
                "tags": [ "4"]
            }
        ]
    "page_number": 1,
    "eop": true,
    "reference": 111111148
}