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

# GET /networks/{networkId}/guest-users

`GET /networks/{networkId}/guest-users`

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.

## Path parameters

- `networkId` string, required

## Query parameters

- `maxResults` integer
- `sortDirection` 'ASC' | 'DESC'
- `sortFields` string
- `username` string
- `billingPeriod` string
- `nextToken` string

## Response `200`

Success

- ListGuestUsersResponse
  - `nextToken` string — The token to use for retrieving the next page of results. If this is not present, there are no more results.
  - `guestlist` GuestUser[], required — A list of guest user objects within the current page.
    - `billingPeriod` string, required — The billing period when this guest user accessed the network (e.g., '2024-01').
    - `username` string, required — The username of the guest user.
    - `usernameHash` string, required — The unique username hash identifier for the guest user.

## 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)