Getting Proxy List with Parameters

Please read the Material Usage Rules on this site.

Description: This method provides functionality for filtering, sorting, and paginating proxies. It can filter results by workspace ID, folder ID, proxy ID, name, and sorting criteria. If parameters are not specified, the response returns the default page of proxies in standard order.

Request parameters:

Parameter	Type	Format	Default	Description
workspaceId	integer	int64	-1	Workspace identifier. -1 means the default workspace.
start	integer	int32	(empty)	Starting index for the list of proxies to retrieve.
total	integer	int32	(empty)	Maximum number of proxies to retrieve.
folderId	string	uuid	(empty)	Optional folder ID for filtering proxies. Pass null to ignore this filter.
id	string	uuid	(empty)	Optional proxy ID to filter. Pass null to ignore this filter.
name	string		(empty)	Optional name for filtering proxies. Pass null to ignore this filter.
sorting	string		(empty)	Optional sorting string to determine the order of the returned proxies. Pass an empty string for default sorting.
proxyUri	string		(empty)	Optional proxy Uri address to filter proxies by. Pass empty string to ignore this filter.

Example request:

GET
CURL:

curl 'http://localhost:8160/v1/proxies?workspaceId=-1&start=0&total=1000&folderId=123e4567-e89b-12d3-a456-426614174000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&sorting=name%20ASC&proxyUri=http%3A%2F%2Flogin%3Apass%40127.0.0.1%3A8080' \
  --header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("http://localhost:8160/v1/proxies?workspaceId=-1&start=0&total=1000&folderId=123e4567-e89b-12d3-a456-426614174000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&sorting=name%20ASC&proxyUri=http%3A%2F%2Flogin%3Apass%40127.0.0.1%3A8080"),
    Headers =
    {
        { "Api-Token", "YOUR_SECRET_TOKEN" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/proxies?workspaceId=&start=&total=&folderId=&id=&name=&sorting=

Additionally:
User-Agent: {-Profile.UserAgent-}
Api-Token: Token from UserArea2.

Response API:

Response code	Result
200 OK	OK
401 Unauthorized	Unauthorized
403 Forbidden	Forbidden
500 Internal Server Error	Internal Server Error

Success Response (200 OK):

{
  "totalCount": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Sample Name",
      "proxyUri": "http://login:pass@127.0.0.1:8080",
      "checkStatus": "Ok",
      "checkStatusLastUpdateTime": "2026-05-19T10:00:00Z",
      "ipChangeUrl": "https://example.com",
      "changeStatus": "Ok",
      "ipV4": "string",
      "ipV6": "string"
    }
  ]
}

Error Response (500):

{
  "message": null
}

---