v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444175204.9 KB

Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.

get/networks/{networkId}/guest-users

Path parameters

networkIdstring required

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

Query parameters

maxResultsinteger

The maximum number of 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 guest users by. Accepted values include 'username' and 'billingPeriod'.

usernamestring

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

billingPeriodstring

Filter results to only include guest users from this billing period (e.g., '2024-01').

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.