---
title: "GET /networks/{networkId}/bots"
method: GET
path: "/networks/{networkId}/bots"
---

# GET /networks/{networkId}/bots

`GET /networks/{networkId}/bots`

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

## Path parameters

- `networkId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer
- `sortFields` string
- `sortDirection` 'ASC' | 'DESC'
- `displayName` string
- `username` string
- `status` integer
- `groupId` string

## Response `200`

Success

- ListBotsResponse
  - `bots` Bot[], required — A list of bot objects matching the specified filters and within the current page.
    - `botId` string — The unique identifier of the bot.
    - `displayName` string — The display name of the bot that is visible to users.
    - `username` string — The username of the bot.
    - `uname` string — The unique username hash identifier for the bot.
    - `pubkey` string — The public key of the bot used for encryption.
    - `status` integer — The current status of the bot (1 for pending, 2 for active).
    - `groupId` string — The ID of the security group to which the bot belongs.
    - `hasChallenge` boolean — Indicates whether the bot has a password set.
    - `suspended` boolean — Indicates whether the bot is currently suspended.
    - `lastLogin` string — The timestamp of the bot's last login.
  - `nextToken` string — The token to use for retrieving the next page of results. If this is not present, there are no more results.

## Other responses

- `480` — ValidationError
- `481` — BadRequestError
- `482` — ResourceNotFoundError
- `483` — ForbiddenError
- `484` — UnauthorizedError
- `485` — InternalServerError
- `486` — RateLimitError

---

[API](https://skmtc.net/aws/apis/wickr.md) · [All operations](https://skmtc.net/aws/apis/wickr/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/wickr/versions/71d396c2af63/schema)