Получить подписчиков списка

Метод lists/getUsers показывает подписчиков одного списка по его ID, частями через count и offset. Что придёт в ответе и пример запроса.

Обновлено

Показывает подписчиков одного списка.

Нужен личный токен с продуктом BotHunter — как получить. Кому доступен: владельцу сообщества и сотрудникам с ролью «Админ (полный доступ)» или «Пользователи».

Параметры

list_id
строка
обязательный

ID списка — id из ответа lists/get.

Пример: 65a6e5f4c0e8f20012d3a111

count
целое число

Сколько записей вернуть: по умолчанию 100, не больше 500.

Пример: 100

offset
целое число

Сколько записей пропустить — для выборки по страницам.

Пример: 0

Результат

Возвращает объект: items — массив подписчиков, total — сколько их всего.

{
  "status": "ok",
  "response": {
    "items": [
      {
        "uid": 102036383,
        "name": "Иван Петров",
        "added_at": 1704067200
      }
    ],
    "total": 1
  }
}

Коды ошибок

Общие ошибки — на странице API.

Код

Когда

7

«Список не найден»: списка с таким list_id нет, он из чужого сообщества или это чёрный список. Та же ошибка, если list_id не передан или записан неверно.

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

Подставьте свой токен вместо <ваш_токен>.

curl
PHP
Python
JavaScript
curl -X POST https://bot-api.targethunter.ru/external-api/v2/lists/getUsers \
  -H "Authorization: Bearer <ваш_токен>" \
  -H "Content-Type: application/json" \
  -d '{"list_id": "65a6e5f4c0e8f20012d3a111", "count": 100, "offset": 0}'
$token = '<ваш_токен>';
$url = 'https://bot-api.targethunter.ru/external-api/v2/lists/getUsers';
$params = [
    'list_id' => '65a6e5f4c0e8f20012d3a111',
    'count' => 100,
    'offset' => 0,
];

$curl = curl_init($url);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($params),
]);

$response = json_decode(curl_exec($curl), true);
curl_close($curl);
import requests

token = '<ваш_токен>'
url = 'https://bot-api.targethunter.ru/external-api/v2/lists/getUsers'
params = {
    'list_id': '65a6e5f4c0e8f20012d3a111',
    'count': 100,
    'offset': 0,
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "list_id": "65a6e5f4c0e8f20012d3a111",
  "count": 100,
  "offset": 0
};

const response = await fetch('https://bot-api.targethunter.ru/external-api/v2/lists/getUsers', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(params),
});
console.log(await response.json());