GET
/
public
/
user
/
proxy_user
/
search
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/proxy_user/search \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": [
    {
      "customer_id": 1955,
      "ip_address_authentications": [
        "17.172.224.47"
      ],
      "proxy_user_creation_datetime": "2023-09-28 12:34:56",
      "proxy_user_id": "stevejobs",
      "proxy_user_ip_address_authentication_limit": 3,
      "proxy_user_is_default": false,
      "proxy_user_is_deleted": false,
      "proxy_user_is_service_restricted": false,
      "proxy_user_is_strict_security": false,
      "proxy_user_last_update_datetime": "2023-09-28 12:34:56",
      "proxy_user_metadata": {
        "resell_order_id": "APPL-9876-5432"
      },
      "proxy_user_password": "apple1984",
      "proxy_user_residential_bytes_limit": 134142432,
      "proxy_user_residential_bytes_used": 31223,
      "restricted_service_ids": [
        "111-230-892"
      ]
    }
  ],
  "item_count": 1,
  "message": "Proxy User search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}

Authorizations

​
X-API-Private-Key
string
header
required

Private API key for user-level authentication.

​
X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

​
proxy_user_id
string

ID of the Proxy User

​
proxy_user_password
string

Password of the Proxy User

​
proxy_user_ip_address_authentication_limit
integer

IP Address authentication limit of the Proxy User (supports min_/max_)

​
proxy_user_is_deleted
boolean

Whether the Proxy User is deleted (true/false)

​
proxy_user_is_service_restricted
boolean

Whether the Proxy User is service restricted (true/false)

​
proxy_user_is_strict_security
boolean

Whether the Proxy User has strict security (true/false)

​
proxy_user_is_default
boolean

Whether the Proxy User is default (true/false)

​
proxy_user_creation_datetime
string

Creation datetime of the Proxy User (supports min_/max_)

​
proxy_user_last_update_datetime
string

Last update datetime of the Proxy User (supports min_/max_)

​
per_page
integer

Number of items per page for pagination

​
page
integer

Page number for pagination

​
sort_by
string

Key for sorting or random.

Response

200 - application/json
Successful Proxy User search

Proxy User search was successful.

​
data
object[]

Array of Proxy User items matching the search criteria up to the limit of per_page paramater.

​
item_count
integer

Total number of Proxy User items returned in the data field.

​
message
string

Status message for the search.

​
page
integer

Current page number of the search results returned.

​
per_page
integer

Number of Proxy User items returned per page.

​
total_count
integer

Total of Proxy User items that match the search filter.