List users in the current account

GET

/users

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.proxyrequest.com/api/v1/users',
  params: {package__id: '550e8400-e29b-41d4-a716-446655440002'},
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/users";

    let querystring = [
        ("package__id", "550e8400-e29b-41d4-a716-446655440002"),
    ];

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url 'https://api.proxyrequest.com/api/v1/users?package__id=550e8400-e29b-41d4-a716-446655440002' \
  --header 'Authorization: Bearer <token>'

Returns users visible to the caller. Resellers see their sub-users, regular customers see only themselves, and administrators can see all users.

Authorizations

BearerAuth
StaticAuth

Parameters

Query Parameters

email

string

string format: uuid

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

package__id

string format: uuid

Filters the visible user list to accounts that have at least one stored order for this package UUID. Orders are matched regardless of whether they are active or expired; this filter never expands the caller’s normal account scope.

Examples

ResidentialPackage

Residential package

550e8400-e29b-41d4-a716-446655440002

search

string

Case-insensitive partial search across user fields: email, username, first_name, and last_name. Separate multiple terms with spaces or commas; every term must match at least one listed field.

username

string

Responses

200

The operation completed successfully.

application/json

object

count

required

integer

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

Customer account with contact details, security settings, package data, referral information, and managed sub-users visible to the caller.

object

required

string format: uuid

username

required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

string

<= 150 characters

email

required

string format: email

<= 254 characters

is_reseller

Reseller

Reseller can create sub-users and manage their data.

boolean

is_marketer

Marketer

Marketer can manage marketing campaigns and view analytics.

boolean

is_superuser

Superuser status

Designates that this user has all permissions without explicitly assigning them.

boolean

date_joined

required

string format: date-time

date_joined_ts

required

Timestamp of when the user joined

integer

first_name

string

<= 150 characters

last_name

string

<= 150 characters

balance

integer

<= 2147483647

language

en - EN * de - DE * fr - FR * it - IT * ru - RU

string

Allowed values: en de fr it ru

country

string

<= 255 characters

state

string

<= 255 characters

city

string

<= 255 characters

address

string

<= 255 characters

zip

string

<= 255 characters

company_name

string

<= 255 characters

company_address

string

<= 255 characters

company_city

string

<= 255 characters

company_postal_code

string

<= 255 characters

company_country

string

<= 255 characters

company_vat_number

string

<= 255 characters

allowed_ips

required

List of IP addresses allowed for this user

Array<string>

blocked_domains

required

List of domains blocked for this user

Array<string>

connection_limit

The maximum number of concurrent connections allowed for this package.

integer

>= -1 <= 2147483647

parent_id

required

ID of the parent user (for sub-accounts)

string

sub_users

required

Number of sub-users managed by this reseller

integer

referrals

required

Number of users referred by this user

integer

referral_id

string

<= 255 characters

referral_code

required

string

referral_data_earned

required

integer

referral_data_pending

required

integer

referral_balance_pending

required

integer

referral_balance_earned

required

integer

currency

required

Currency information for the user’s transactions

object

key

additional properties

string

coupons

required

Available coupons for this user

Array<object>

object

key

additional properties

data

required

Available data allowance for the user

integer

nullable

data_spent

required

Amount of data consumed by the user

integer

nullable

data_updated

required

Last update timestamp for user’s data

string format: date-time

nullable

proxy_password

required

Proxy authentication password

string

nullable

proxy_password_reset

required

Last proxy password reset timestamp

string format: date-time

nullable

Examples

example

Example response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "username": "developer",
      "email": "[email protected]",
      "is_reseller": true,
      "is_marketer": true,
      "is_superuser": true,
      "date_joined": "2026-07-01T12:30:00Z",
      "date_joined_ts": 1,
      "first_name": "Dana",
      "last_name": "Morgan",
      "balance": 1,
      "language": "en",
      "country": "us",
      "state": "state",
      "city": "los_angeles",
      "address": "address",
      "zip": "zip",
      "company_name": "company name",
      "company_address": "company address",
      "company_city": "company city",
      "company_postal_code": "company postal code",
      "company_country": "company country",
      "company_vat_number": "company vat number",
      "allowed_ips": [
        "198.51.100.25"
      ],
      "blocked_domains": [
        "blocked.example"
      ],
      "connection_limit": 1,
      "parent_id": "550e8400-e29b-41d4-a716-446655440001",
      "sub_users": 1,
      "referrals": 1,
      "referral_id": "550e8400-e29b-41d4-a716-446655440001",
      "referral_code": "referral code",
      "referral_data_earned": 1,
      "referral_data_pending": 1,
      "referral_balance_pending": 1,
      "referral_balance_earned": 1,
      "currency": "USD",
      "coupons": [
        {}
      ],
      "data": 1073741824,
      "data_spent": 1073741824,
      "data_updated": "2026-07-01T12:30:00Z",
      "proxy_password": "p9W4rT2xK7mQ",
      "proxy_password_reset": "2026-07-01T12:30:00Z"
    }
  ]
}

400

The request is malformed or violates a business rule.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ],
  "translation": "errors.request.invalid"
}

401

Authentication credentials are missing, expired, or invalid.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

{
  "detail": "Authentication credentials were not provided."
}

403

The authenticated account cannot perform this operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

translation

Stable translation key suitable for client localisation.

string

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

{
  "detail": "You do not have permission to perform this action."
}