Getting Accessible Browser Profiles

Please read the Material Usage Rules on this site.

Description: This method retrieves a list of profiles with their attributes from the specified workspace and the folder. It is possible to optionally filter results by ID, name, tags, and sorting.

Request parameters:

Parameter	Type	Format	Default	Description
workspaceId	integer	int64	-1	Workspace identifier. -1 means the default workspace.
start	integer	int32	(empty)	Zero-based index of the first profile to retrieve.
total	integer	int32	(empty)	Maximum number of results to return.
folderId	string	uuid	(empty)	Folder identifier for filtering (optional).
id	string	uuid	(empty)	Profile identifier for filtering (optional).
name	string		(empty)	Profile name for filtering (optional).
tags	string		(empty)	Profile tags separated by spaces. (e.g. 1 2 3 4)
tagOperator	string		(empty)	Specifies the logical operator for tag filtering: "or" returns profiles with at least one matching tag, "and" returns profiles with all specified tags. Defaults to "or".
sorting	string		(empty)	Sorting parameters (optional). Id, ContainerId, Name, CreationTime, User.Sex, User.Name, User.Surname, User.Age, User.Country, OperationSystem.Name, OperationSystem.Version, Brand.Name, Brand.Version, Proxy, Proxy.Name, ProfileState.DisplayStatus, ProfileState.Description, Status, OperationalState.OperationStatus, OperationalState.CanChangeOperationStatus, UsedTime, LastStartTime, LastErrorMessage, Tags, Tags.Id, Notes.

Example request:

GET
CURL:

curl 'http://localhost:8160/v1/profiles?workspaceId=-1&start=0&total=1000&folderId=123e4567-e89b-12d3-a456-426614174000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&tags=tag1%20tag2&tagOperator=And&sorting=name%20ASC' \
  --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/profiles?workspaceId=-1&start=0&total=1000&folderId=123e4567-e89b-12d3-a456-426614174000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&tags=tag1%20tag2&tagOperator=And&sorting=name%20ASC"),
    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/profiles?workspaceId=-1&start=0&total=1000&folderId=&id=&name=&tags=&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",
      "name": "Sample Name",
      "folderId": "123e4567-e89b-12d3-a456-426614174000",
      "creationTime": "2026-05-19T10:00:00Z",
      "user": {
        "sex": "string",
        "name": "Sample Name",
        "surname": "Sample Name",
        "age": 1,
        "country": "string"
      },
      "browser": {
        "operationSystem": {
          "name": "Sample Name",
          "version": "1.0.0"
        },
        "brand": {
          "name": "Sample Name",
          "version": "1.0.0"
        }
      },
      "proxy": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Sample Name"
      },
      "status": "Ok",
      "usedTimeSeconds": 12.5,
      "lastStartTime": "2026-05-19T10:00:00Z",
      "lastErrorMessage": null,
      "tags": [
        {
          "name": "Sample Name",
          "color": "#4F46E5"
        }
      ],
      "notes": "string",
      "presetId": "123e4567-e89b-12d3-a456-426614174000",
      "location": "Local",
      "profileState": "Stopped",
      "syncStatus": null
    }
  ]
}

Error Response (500):

{
  "message": null
}

---