Перейти к основному содержимому

Получение доступных профилей браузера

Описание: Этот метод получает список профилей с их атрибутами из указанного рабочего пространства и папки. Можно дополнительно фильтровать результаты по ID, имени, тегам и параметрам сортировки.

Параметры запроса:

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1Идентификатор рабочего пространства. -1 означает рабочее пространство по умолчанию.
startintegerint320Индекс (с нуля) первой папки с профилем, которую нужно получить. По умолчанию 0.
totalintegerint321000Максимальное количество результатов для возврата
folderIdstringuuid(empty)Идентификатор папки для фильтрации (необязательно).
idstringuuid(empty)Идентификатор профиля для фильтрации (необязательно).
namestring(empty)Имя профиля для фильтрации (необязательно).
tagsstring(empty)Теги для фильтрации (необязательно). Несколько тегов можно разделять пробелами.
tagOperatorstring(empty)Логический оператор для фильтрации по тегам: Or возвращает профили с любым из указанных тегов, And — профили, содержащие все указанные теги.
sortingstring(empty)Параметры сортировки (необязательно). 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

Пример запроса:

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.Net.Http.Headers;
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=123e4567-e89b-12d3-a456-426614174000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&tags=tag1 tag2&tagOperator=And&sorting=name ASC

Дополнительно:
User-Agent: {-Profile.UserAgent-}
Api-Token: токен из UserArea2.

Ответ API:

Код ответаРезультат
200 OKУспешно
401 UnauthorizedНе авторизован
403 ForbiddenДоступ запрещен
500 Internal Server ErrorВнутренняя ошибка сервера

Успешный ответ (200 OK):

{
"totalCount": 1,
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sample Name",
"folderId": "123e4567-e89b-12d3-a456-426614174000",
"creationTime": "2025-07-25T09:34:29.768Z",
"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"
}
]
}

Ответ с ошибкой (500):

{
"message": null
}