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

# GET /networks/{networkId}/users

`GET /networks/{networkId}/users`

Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.

## Path parameters

- `networkId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer
- `sortFields` string
- `sortDirection` 'ASC' | 'DESC'
- `firstName` string, password
- `lastName` string, password
- `username` string
- `status` integer
- `groupId` string

## Response `200`

Success

- ListUsersResponse
  - `nextToken` string — The token to use for retrieving the next page of results. If this is not present, there are no more results.
  - `users` User[] — A list of user objects matching the specified filters and within the current page.
    - `userId` string — The unique identifier for the user within the network.
    - `firstName` string, password — The first name of the user.
    - `lastName` string, password — The last name of the user.
    - `username` string — The email address or username of the user. For bots, this must end in 'bot'.
    - `securityGroups` SecurityGroupId[] — A list of security group IDs to which the user is assigned, determining their permissions and feature access.
    - `isAdmin` boolean — Indicates whether the user has administrator privileges in the network.
    - `suspended` boolean — Indicates whether the user is currently suspended and unable to access the network.
    - `status` integer — The current status of the user (1 for pending invitation, 2 for active).
    - `otpEnabled` boolean — Indicates whether one-time password (OTP) authentication is enabled for the user.
    - `scimId` string — The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.
    - `type` string — The descriptive type of the user account (e.g., 'user').
    - `cell` string — The phone number minus country code, used for cloud deployments.
    - `countryCode` string — The country code for the user's phone number, used for cloud deployments.
    - `challengeFailures` integer — The number of failed password attempts for enterprise deployments, used for account lockout policies.
    - `isInviteExpired` boolean — Indicates whether the user's email invitation code has expired, applicable to cloud deployments.
    - `isUser` boolean — Indicates whether this account is a user (as opposed to a bot or other account type).
    - `inviteCode` string — The invitation code for this user, used during registration to join the network.
    - `codeValidation` boolean — Indicates whether the user can be verified through a custom invite code.
    - `uname` string — The unique identifier for the 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)