Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444175204.9 KB

Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

get/networks/{networkId}/guest-users/blocklist

Path parameters

networkIdstring required

The ID of the Wickr network from which to list blocked guest users.

Query parameters

maxResultsinteger

The maximum number of blocked guest users to return in a single page. Valid range is 1-100. Default is 10.

sortDirection'ASC' | 'DESC'

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

sortFieldsstring

The field to sort blocked guest users by. Accepted values include 'username', 'admin', and 'modified'.

usernamestring

Filter results to only include blocked guest users with usernames matching this value.

adminstring

Filter results to only include blocked guest users that were blocked by this administrator.

nextTokenstring

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

Response

Success

nextTokenstring

The token to use for retrieving the next page of results. If this is not present, there are no more results.