---
title: "List site password protection users"
method: GET
path: "/v1/sites/{id}/password_protection/users"
tags: ["Password Protection"]
---

# List site password protection users

`GET /v1/sites/{id}/password_protection/users`

List users who can access the site with a password while it is password protected

## Path parameters

- `id` integer, required — ID of the Site you are interacting with

## Query parameters

- `page` integer — Page of results to include (default = 1)
- `per_page` integer — Results per page
- `search` string — search for username matching this string
- `sort` 'username'
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListPasswordProtectionUsersResponse
  - `success` boolean — whether the request succeeded
  - `errors` string[]
  - `messages` string[], nullable
  - `metadata` object
    - `page` integer — Page number of the results
    - `page_size` integer — Number of results per page
    - `total` integer — Total number of results
    - `sort` string — Sorting criteria
    - `direction` 'asc' | 'desc' — Sorting direction
  - `result` PasswordProtectionUserList
    - `users` PasswordProtectionUser[]
      - `user_id` string — ID of the user
      - `username` string — username who can access the site while password protection is turned on

## Other responses

- `400` — Bad Request
- `401` — Authentication failed
- `403` — Not authorized to access endpoint
- `404` — Given site not found for user
- `405` — Invalid input
- `500` — Internal error

---

[API](https://skmtc.net/rocket/apis/rocket-net-api.md) · [All operations](https://skmtc.net/rocket/apis/rocket-net-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocket/rocket-net-api/revisions/db0dcbbc5764/schema)