Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444175204.9 KB

Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.

get/networks/{networkId}/bots

Path parameters

networkIdstring required

The ID of the Wickr network from which to list bots.

Query parameters

nextTokenstring

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

maxResultsinteger

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

sortFieldsstring

The fields to sort bots by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'displayName', 'status', and 'groupId'.

sortDirection'ASC' | 'DESC'

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

displayNamestring

Filter results to only include bots with display names matching this value.

usernamestring

Filter results to only include bots with usernames matching this value.

statusinteger

Filter results to only include bots with this status (1 for pending, 2 for active).

groupIdstring

Filter results to only include bots belonging to this security group.

Response

Success

nextTokenstring

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