v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Password Protection

List site password protection users

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

get/v1/sites/{id}/password_protection/users

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

pageinteger

Page of results to include (default = 1)

per_pageinteger

Results per page

Example:10
searchstring

search for username matching this string

Example:secret
sort'username'
Example:username

property to sort the results by

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": {
    "users": [
      {
        "user_id": "9",
        "username": "secretuser"
      }
    ]
  }
}