Skip to main content
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"
  }
}
'
{
  "data": [
    {
      "has_access": true,
      "proxy_user_id": "stevejobs",
      "proxy_user_is_default": false
    }
  ],
  "message": "Proxy user list options successfully retrieved."
}

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.

​
message
string

Success message.

Example:

"Proxy user list options successfully retrieved."