Основы API
Методы API

Список сотрудников тега

GET/group_tags/{id}/users
group_tags:read

Метод для получения актуального списка сотрудников тега.

Параметры пути

id
integer, (int32)
*
Идентификатор тега
Пример:9111

Параметры строки запроса

limit
integer, (int32)
Количество возвращаемых сущностей за один запрос
Пример:1
По умолчанию:
50
Диапазон:
1 — 50
cursor
string
Курсор для пагинации (из meta.paginate.next_page)
Пример:eyJpZCI6MTAsImRpciI6ImFzYyJ9

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор пользователя
Пример:12
first_name
string
*
Имя
Пример:Олег
last_name
string
*
Фамилия
Пример:Петров
nickname
string
*
Имя пользователя
Пример:
email
string
*
Электронная почта
Пример:olegp@example.com
phone_number
string
*
Телефон
Пример:
department
string
*
Департамент
Пример:Продукт
title
string
*
Должность
Пример:CIO
role
string
*
Уровень доступа
Возможные значения
Пример:admin
suspended
boolean
*
Деактивация пользователя
Пример:false
invite_status
string
*
Статус приглашения
Возможные значения
Пример:confirmed
list_tags[]
array of strings
*
Массив тегов, привязанных к сотруднику
Пример:["Product","Design"]
custom_properties[]
array of objects
*
Дополнительные поля сотрудника
id
integer, (int32)
*
Идентификатор поля
Пример:1678
name
string
*
Название поля
Пример:Город
data_type
string
*
Тип поля
Возможные значения
Пример:string
value
string
*
Значение
Пример:Санкт-Петербург
user_status
nullableobject
*
Статус
emoji
string
*
Emoji символ статуса
Пример:🎮
title
string
*
Текст статуса
Пример:Очень занят
expires_at
nullablestring, (date-time)
*
Срок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2024-04-08T10:00:00.000Z
is_away
boolean
*
Режим «Нет на месте»
Пример:false
away_message
nullableobject
*
Сообщение при режиме «Нет на месте». Отображается в профиле пользователя, а также при отправке ему личного сообщения или упоминании в чате.
text
string
*
Текст сообщения
Пример:Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov.
bot
boolean
*
Является ботом
Пример:false
sso
boolean
*
Использует ли пользователь SSO
Пример:false
created_at
string, (date-time)
*
Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2020-06-08T09:32:57.000Z
last_activity_at
string, (date-time)
*
Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2025-01-20T13:40:07.000Z
time_zone
string
*
Часовой пояс пользователя
Пример:Europe/Moscow
image_url
nullablestring
*
Ссылка на скачивание аватарки пользователя
Пример:https://app.pachca.com/users/12/photo.jpg
meta
object
Метаданные пагинации
paginate
object
Вспомогательная информация
next_page
string
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
Список сотрудников тега
# Для получения следующей страницы используйте cursor из meta.paginate.next_pagecurl "https://api.pachca.com/api/shared/v1/group_tags/9111/users?limit=1" \  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Ответ 200
{  "data": [    {      "id": 12,      "first_name": "Олег",      "last_name": "Петров",      "nickname": "",      "email": "olegp@example.com",      "phone_number": "",      "department": "Продукт",      "title": "CIO",      "role": "admin",      "suspended": false,      "invite_status": "confirmed",      "list_tags": [        "Product",        "Design"      ],      "custom_properties": [        {          "id": 1678,          "name": "Город",          "data_type": "string",          "value": "Санкт-Петербург"        }      ],      "user_status": {        "emoji": "🎮",        "title": "Очень занят",        "expires_at": "2024-04-08T10:00:00.000Z",        "is_away": false,        "away_message": {          "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."        }      },      "bot": false,      "sso": false,      "created_at": "2020-06-08T09:32:57.000Z",      "last_activity_at": "2025-01-20T13:40:07.000Z",      "time_zone": "Europe/Moscow",      "image_url": "https://app.pachca.com/users/12/photo.jpg"    }  ],  "meta": {    "paginate": {      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3"    }  }}