API referenceProxy users
List proxy users
GET
Passwords are included. Sort: username, created_at, residential_bytes_used, mobile_bytes_used. Filters: status, username, like_username, is_default, min_/max_*_bytes_used, metadata., include_deleted.
ApiKeyheader
X-API-Key<token>prx_live_<40 base62>
page?integerFormat
int64Range
1 <= valueDefault
1per_page?integerFormat
int64Range
1 <= value <= 100Default
25sort_by?stringusername | created_at | residential_bytes_used | mobile_bytes_used, optionally with _desc. Default created_at_desc.
status?stringValue in
"active""disabled"username?stringlike_username?stringCase-insensitive contains, % wildcard.
is_default?booleanmin_residential_bytes_used?integerFormat
int64max_residential_bytes_used?integerFormat
int64min_mobile_bytes_used?integerFormat
int64max_mobile_bytes_used?integerFormat
int64include_deleted?booleanOK
application/json- response
data*array<>|nullmessage*stringpage*integerCurrent page (1-based).
Format
int64per_page*integerItems per page (1–100).
Format
int64total_count*integerExact total across all pages.
Format
int64curl -X GET "https://example.com/v1/proxy-users"{ "data": [ { "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_default": true, "metadata": { "property1": null, "property2": null }, "mobile_bytes_limit": 0, "mobile_bytes_used": 0, "password": "string", "residential_bytes_limit": 0, "residential_bytes_used": 0, "status": "active", "updated_at": "2019-08-24T14:15:22Z", "username": "string", "whitelist_ips": [ "string" ] } ], "message": "OK", "page": 1, "per_page": 25, "total_count": 137}