Get Proxy User List Options

curl --request POST \
  --url https://api.byteful.com/1.0/public/user/proxy/list/options \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "proxy_ids": [
    "19efadd4-5814-4986-90be-4460e7d05c29",
    "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"
  ],
  "search_filter": {
    "country_id": "US",
    "proxy_status": "in_use",
    "service_id": "API-1234-5678"
  }
}
'

import requests

url = "https://api.byteful.com/1.0/public/user/proxy/list/options"

payload = {
    "proxy_ids": ["19efadd4-5814-4986-90be-4460e7d05c29", "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"],
    "search_filter": {
        "country_id": "US",
        "proxy_status": "in_use",
        "service_id": "API-1234-5678"
    }
}
headers = {
    "Content-Type": "<content-type>",
    "X-API-Private-Key": "<api-key>",
    "X-API-Public-Key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Content-Type': '<content-type>',
    'X-API-Private-Key': '<api-key>',
    'X-API-Public-Key': '<api-key>'
  },
  body: JSON.stringify({
    proxy_ids: ['19efadd4-5814-4986-90be-4460e7d05c29', '1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3'],
    search_filter: {country_id: 'US', proxy_status: 'in_use', service_id: 'API-1234-5678'}
  })
};

fetch('https://api.byteful.com/1.0/public/user/proxy/list/options', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.byteful.com/1.0/public/user/proxy/list/options",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'proxy_ids' => [
        '19efadd4-5814-4986-90be-4460e7d05c29',
        '1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3'
    ],
    'search_filter' => [
        'country_id' => 'US',
        'proxy_status' => 'in_use',
        'service_id' => 'API-1234-5678'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Private-Key: <api-key>",
    "X-API-Public-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.byteful.com/1.0/public/user/proxy/list/options"

	payload := strings.NewReader("{\n  \"proxy_ids\": [\n    \"19efadd4-5814-4986-90be-4460e7d05c29\",\n    \"1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3\"\n  ],\n  \"search_filter\": {\n    \"country_id\": \"US\",\n    \"proxy_status\": \"in_use\",\n    \"service_id\": \"API-1234-5678\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Private-Key", "<api-key>")
	req.Header.Add("X-API-Public-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.byteful.com/1.0/public/user/proxy/list/options")
  .header("Content-Type", "<content-type>")
  .header("X-API-Private-Key", "<api-key>")
  .header("X-API-Public-Key", "<api-key>")
  .body("{\n  \"proxy_ids\": [\n    \"19efadd4-5814-4986-90be-4460e7d05c29\",\n    \"1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3\"\n  ],\n  \"search_filter\": {\n    \"country_id\": \"US\",\n    \"proxy_status\": \"in_use\",\n    \"service_id\": \"API-1234-5678\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/proxy/list/options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n  \"proxy_ids\": [\n    \"19efadd4-5814-4986-90be-4460e7d05c29\",\n    \"1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3\"\n  ],\n  \"search_filter\": {\n    \"country_id\": \"US\",\n    \"proxy_status\": \"in_use\",\n    \"service_id\": \"API-1234-5678\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "has_access": true,
      "proxy_user_id": "stevejobs",
      "proxy_user_is_default": false
    }
  ],
  "message": "Proxy user list options successfully retrieved."
}

{
  "message": "Either proxy_ids or search_filter must be provided, but not both."
}

{
  "message": "No proxies found matching the specified criteria."
}

Proxy

Get Proxy User List Options

This endpoint returns a list of all active proxy users on the customer’s account, along with a boolean flag indicating whether each proxy user has access to export/use the specified proxies based on their access type and ACL rules.

Access Logic:

Unrestricted (all): Proxy user has access to all proxies on the account
Service Restricted: Proxy user has access only if they have ACL entries for all services containing the specified proxies
Proxy Restricted: Proxy user has access only if they have ACL entries for all specified proxies

Note: This endpoint is intentionally a POST request (rather than GET) to support large lists of proxy IDs in the request body.

POST

public

user

proxy

list

options

Get Proxy User List Options

curl --request POST \
  --url https://api.byteful.com/1.0/public/user/proxy/list/options \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '
{
  "proxy_ids": [
    "19efadd4-5814-4986-90be-4460e7d05c29",
    "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"
  ],
  "search_filter": {
    "country_id": "US",
    "proxy_status": "in_use",
    "service_id": "API-1234-5678"
  }
}
'

import requests

url = "https://api.byteful.com/1.0/public/user/proxy/list/options"

payload = {
    "proxy_ids": ["19efadd4-5814-4986-90be-4460e7d05c29", "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"],
    "search_filter": {
        "country_id": "US",
        "proxy_status": "in_use",
        "service_id": "API-1234-5678"
    }
}
headers = {
    "Content-Type": "<content-type>",
    "X-API-Private-Key": "<api-key>",
    "X-API-Public-Key": "<api-key>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Content-Type': '<content-type>',
    'X-API-Private-Key': '<api-key>',
    'X-API-Public-Key': '<api-key>'
  },
  body: JSON.stringify({
    proxy_ids: ['19efadd4-5814-4986-90be-4460e7d05c29', '1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3'],
    search_filter: {country_id: 'US', proxy_status: 'in_use', service_id: 'API-1234-5678'}
  })
};

fetch('https://api.byteful.com/1.0/public/user/proxy/list/options', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.byteful.com/1.0/public/user/proxy/list/options",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'proxy_ids' => [
        '19efadd4-5814-4986-90be-4460e7d05c29',
        '1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3'
    ],
    'search_filter' => [
        'country_id' => 'US',
        'proxy_status' => 'in_use',
        'service_id' => 'API-1234-5678'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: <content-type>",
    "X-API-Private-Key: <api-key>",
    "X-API-Public-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.byteful.com/1.0/public/user/proxy/list/options"

	payload := strings.NewReader("{\n  \"proxy_ids\": [\n    \"19efadd4-5814-4986-90be-4460e7d05c29\",\n    \"1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3\"\n  ],\n  \"search_filter\": {\n    \"country_id\": \"US\",\n    \"proxy_status\": \"in_use\",\n    \"service_id\": \"API-1234-5678\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	req.Header.Add("X-API-Private-Key", "<api-key>")
	req.Header.Add("X-API-Public-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.byteful.com/1.0/public/user/proxy/list/options")
  .header("Content-Type", "<content-type>")
  .header("X-API-Private-Key", "<api-key>")
  .header("X-API-Public-Key", "<api-key>")
  .body("{\n  \"proxy_ids\": [\n    \"19efadd4-5814-4986-90be-4460e7d05c29\",\n    \"1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3\"\n  ],\n  \"search_filter\": {\n    \"country_id\": \"US\",\n    \"proxy_status\": \"in_use\",\n    \"service_id\": \"API-1234-5678\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/proxy/list/options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'
request.body = "{\n  \"proxy_ids\": [\n    \"19efadd4-5814-4986-90be-4460e7d05c29\",\n    \"1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3\"\n  ],\n  \"search_filter\": {\n    \"country_id\": \"US\",\n    \"proxy_status\": \"in_use\",\n    \"service_id\": \"API-1234-5678\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "has_access": true,
      "proxy_user_id": "stevejobs",
      "proxy_user_is_default": false
    }
  ],
  "message": "Proxy user list options successfully retrieved."
}

{
  "message": "Either proxy_ids or search_filter must be provided, but not both."
}

{
  "message": "No proxies found matching the specified criteria."
}

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.

Headers

Content-Type

string

default:application/json

required

Content type for the request body as application/json.

Body

application/json

proxy_ids

string<uuid>[]

List of proxy UUIDs to check access against. Either proxy_ids or search_filter must be provided, but not both.

Example:

[
  "19efadd4-5814-4986-90be-4460e7d05c29",
  "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"
]

search_filter

object

Search filter object to find proxies (same format as /proxy/list_by_search endpoint). Either proxy_ids or search_filter must be provided, but not both.

Example:

{
  "country_id": "US",
  "proxy_status": "in_use",
  "service_id": "API-1234-5678"
}

Response

Successfully retrieved proxy user list options.

data

object[]

List of proxy users with access information.

Show child attributes

message

string

Success message.

Example:

"Proxy user list options successfully retrieved."

Customer

Proxy

Proxy User

Proxy User ACL

Residential

Residential Availability

Residential Ledger

Mobile

Mobile Availability

Mobile Ledger

Service

Service Adjustment

Checkout

Analytics

Product

ASN

Continent

Country

Subdivision

City

Zip Code

Proxy Tester

Get Proxy User List Options

Authorizations

Headers

Body

Response