getWhitelistUsers

Retrieves the whitelisted signups for your app, one page at a time.

💡 Results are paginated. Keep requesting the next page_number until the response comes back with "eop": true.

Request

method is "getWhitelistUsers".

Field	Type	Required	Description
`app_id`	String	Yes	The app whose whitelist you want.
`page_number`	Number	Yes	Page to retrieve, starting at `0`.
`reference`	String	Yes	Your id for this request. Echoed back in the response.
`page_size`	Number	Optional	Entries per page. Defaults to 50.

Preconditions

Requirement	Why
`"Signup Management"` permission	Needed to read or manage whitelist and blacklist.
User Whitelist enabled	Turn on the Use Whitelist flag under Web Admin → Signup Settings → Signup Filter, or filtering is not enforced.

Response

getWhitelistUsersResponse

Field	Type	Returned	Description
`method`	String	Yes	`"getWhitelistUsersResponse"`
`signups`	Array of Signup	Yes	The whitelisted signups on this page.
`app_id`	String	Yes	Echoed from the request.
`page_number`	Number	Optional	The page this result represents.
`eop`	Boolean	Conditional	End of pages. `true` when there is nothing more to fetch. Defaults to `false`.
`reference`	String	Optional	Echoed from the request.

SDKs

SDK	Call	Callback
Java	`api.getWhiteList(appId, reference);`	`onWhiteList(WhiteList whiteList)`
JavaScript	`api.getWhiteList(appId, reference);`	`onWhiteList(whiteList)`
Python	`napi.get_white_list(app_id=app_id, reference=reference)`	`on_white_list(self, white_list)`

Example

Request

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

java
api.getWhiteList("90090684293000559", "111111148");

javascript
api.getWhiteList("90090684293000559", "111111148");

python
napi.get_white_list(app_id="90090684293000559", reference="111111148")

Response

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