Модели

Все модели данных, возвращаемые в ответах API. Каждая модель содержит связанные методы и таблицу свойств.

Методы POSTПолучение подписи и POSTЗагрузка файла не возвращают модели данных.

Дополнительное поле

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор поля1678
namestringНазвание поля"Город"
data_typeCustomPropertyDataTypeТип поля"string"

Токен доступа

ПараметрТипОписаниеПример
idinteger(int64)Идентификатор токена4827
tokenstringМаскированный токен (видны первые 8 и последние 4 символа)"cH5kR9mN...x7Qp"
namestring| nullПользовательское имя токена"Мой API токен"
user_idinteger(int64)Идентификатор владельца токена12
scopesarray of OAuthScopeСписок скоупов токена
[
  "messages:read",
  "chats:read"
]
created_atstring(date-time)Дата создания токена"2025-01-15T10:30:00.000Z"
revoked_atstring(date-time)| nullДата отзыва токенаnull
expires_ininteger(int32)| nullВремя жизни токена в секундахnull
last_used_atstring(date-time)| nullДата последнего использования токена"2025-02-24T14:20:00.000Z"

Статус пользователя

ПараметрТипОписаниеПример
emojistringEmoji символ статуса"🎮"
titlestringТекст статуса"Очень занят"
expires_atstring(date-time)| nullСрок жизни статуса (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2024-04-08T10:00:00.000Z"
is_awaybooleanРежим «Нет на месте»false
away_messageobject| nullСообщение при режиме «Нет на месте». Отображается в профиле пользователя, а также при отправке ему личного сообщения или упоминании в чате.
{
  "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."
}

Сотрудник

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор пользователя12
first_namestringИмя"Олег"
last_namestringФамилия"Петров"
nicknamestringИмя пользователя""
emailstringЭлектронная почта"olegp@example.com"
phone_numberstringТелефон""
departmentstringДепартамент"Продукт"
titlestringДолжность"CIO"
roleUserRoleУровень доступа"admin"
suspendedbooleanДеактивация пользователяfalse
invite_statusInviteStatusСтатус приглашения"confirmed"
list_tagsarray of stringМассив тегов, привязанных к сотруднику
[
  "Product",
  "Design"
]
custom_propertiesarray of CustomPropertyДополнительные поля сотрудника
[
  {
    "id": 1678,
    "name": "Город",
    "data_type": "string",
    "value": "Санкт-Петербург"
  }
]
user_statusUserStatus| nullСтатус
{
  "emoji": "🎮",
  "title": "Очень занят",
  "expires_at": "2024-04-08T10:00:00.000Z",
  "is_away": false,
  "away_message": {
    "text": "Я в отпуске до 15 апреля. По срочным вопросам обращайтесь к @ivanov."
  }
}
botbooleanЯвляется ботомfalse
ssobooleanИспользует ли пользователь SSOfalse
created_atstring(date-time)Дата создания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2020-06-08T09:32:57.000Z"
last_activity_atstring(date-time)Дата последней активности пользователя (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2025-01-20T13:40:07.000Z"
time_zonestringЧасовой пояс пользователя"Europe/Moscow"
image_urlstring| nullСсылка на скачивание аватарки пользователя"https://app.pachca.com/users/12/photo.jpg"

Тег

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор тега9111
namestringНазвание тега"Design"
users_countinteger(int32)Количество сотрудников, которые имеют этот тег6

Чат

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор созданного чата334
namestringНазвание"🤿 aqua"
created_atstring(date-time)Дата и время создания чата (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2021-08-28T15:56:53.000Z"
owner_idinteger(int32)Идентификатор пользователя, создавшего чат185
member_idsarray of integerМассив идентификаторов пользователей, участников
[
  185,
  186,
  187
]
group_tag_idsarray of integerМассив идентификаторов тегов, участников
[
  9111
]
channelbooleanЯвляется каналомtrue
personalbooleanЯвляется личным чатомfalse
publicbooleanОткрытый доступfalse
last_message_atstring(date-time)Дата и время создания последнего сообщения в чате (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2021-08-28T15:56:53.000Z"
meet_room_urlstringСсылка на Видеочат"https://meet.pachca.com/aqua-94bb21b5"

Тред

ПараметрТипОписаниеПример
idinteger(int64)Идентификатор созданного треда (используется для отправки [новых комментариев](POST /messages) в тред)265142
chat_idinteger(int64)Идентификатор чата треда (используется для отправки [новых комментариев](POST /messages) в тред и получения [списка комментариев](GET /messages))2637266155
message_idinteger(int64)Идентификатор сообщения, к которому был создан тред154332686
message_chat_idinteger(int64)Идентификатор чата сообщения2637266154
updated_atstring(date-time)Дата и время обновления треда (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2023-02-01T19:20:47.204Z"

Сообщение

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор сообщения194275
entity_typeMessageEntityTypeТип сущности, к которой относится сообщение"discussion"
entity_idinteger(int32)Идентификатор сущности, к которой относится сообщение (беседы/канала, треда или пользователя)334
chat_idinteger(int32)Идентификатор чата, в котором находится сообщение334
root_chat_idinteger(int32)Идентификатор корневого чата. Для сообщений в тредах — идентификатор чата, в котором был создан тред. Для обычных сообщений совпадает с chat_id.334
contentstringТекст сообщения"Вчера мы продали 756 футболок (что на 10% больше, чем в прошлое воскресенье)"
user_idinteger(int32)Идентификатор пользователя, создавшего сообщение12
created_atstring(date-time)Дата и время создания сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2021-08-28T15:57:23.000Z"
urlstringПрямая ссылка на сообщение"https://app.pachca.com/chats/334?message=194275"
filesarray of FileПрикрепленные файлы
[
  {
    "id": 3560,
    "key": "attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png",
    "name": "congrat.png",
    "file_type": "image",
    "url": "https://pachca-prod-uploads.s3.storage.selcloud.ru/attaches/files/12/21zu7934-02e1-44d9-8df2-0f970c259796/congrat.png?response-cache-control=max-age%3D3600%3B&response-content-disposition=attachment&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=142155_staply%2F20231107%2Fru-1a%2Fs3%2Faws4_request&X-Amz-Date=20231107T160412&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=98765asgfadsfdSaDSd4sdfg35asdf67sadf8"
  }
]
buttonsarray of array of Button| nullМассив строк, каждая из которых представлена массивом кнопок
[
  [
    {
      "text": "Подробнее"
    }
  ]
]
threadThread| nullТред сообщения
{
  "id": 265142,
  "chat_id": 2637266155,
  "message_id": 154332686,
  "message_chat_id": 2637266154,
  "updated_at": "2023-02-01T19:20:47.204Z"
}
forwardingForwarding| nullИнформация о пересланном сообщении
{
  "original_message_id": 194275,
  "original_chat_id": 334,
  "author_id": 12,
  "original_created_at": "2025-01-15T10:30:00.000Z",
  "original_thread_id": null,
  "original_thread_message_id": null,
  "original_thread_parent_chat_id": null
}
parent_message_idinteger(int32)| nullИдентификатор сообщения, к которому написан ответnull
display_avatar_urlstring| nullСсылка на аватарку отправителя сообщенияnull
display_namestring| nullПолное имя отправителя сообщенияnull
changed_atstring(date-time)| nullДата и время последнего редактирования сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2021-08-28T16:10:00.000Z"
deleted_atstring(date-time)| nullДата и время удаления сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZnull

Реакция на сообщение

ПараметрТипОписаниеПример
user_idinteger(int32)Идентификатор пользователя, который добавил реакцию12
created_atstring(date-time)Дата и время добавления реакции (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2024-01-20T10:30:00.000Z"
codestringEmoji символ реакции"👍"
namestringНазвание emoji реакции":+1::skin-tone-1:"

Напоминание

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор напоминания22283
kindTaskKindТип"reminder"
contentstringОписание"Забрать со склада 21 заказ"
due_atstring(date-time)| nullСрок выполнения напоминания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2020-06-05T09:00:00.000Z"
priorityinteger(int32)Приоритет2
user_idinteger(int32)Идентификатор пользователя-создателя напоминания12
chat_idinteger(int32)| nullИдентификатор чата, к которому привязано напоминание334
statusTaskStatusСтатус напоминания"undone"
created_atstring(date-time)Дата и время создания напоминания (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2020-06-04T10:37:57.000Z"
performer_idsarray of integerМассив идентификаторов пользователей, привязанных к напоминанию как «ответственные»
[
  12
]
all_daybooleanНапоминание на весь день (без указания времени)false
custom_propertiesarray of CustomPropertyДополнительные поля напоминания
[
  {
    "id": 1678,
    "name": "Город",
    "data_type": "string",
    "value": "Санкт-Петербург"
  }
]

Представление

ПараметрТипОписаниеПример
typestringСпособ открытия представления"modal"
trigger_idstringУникальный идентификатор события (полученный, например, в исходящем вебхуке о нажатии кнопки)"791a056b-006c-49dd-834b-c633fde52fe8"
private_metadatastringНеобязательная строка, которая будет отправлена в ваше приложение при отправке пользователем заполненной формы. Используйте это поле, например, для передачи в формате JSON какой то дополнительной информации вместе с заполненной пользователем формой."{"timeoff_id":4378}"
callback_idstringНеобязательный идентификатор для распознавания этого представления, который будет отправлен в ваше приложение при отправке пользователем заполненной формы. Используйте это поле, например, для понимания, какую форму должен был заполнить пользователь."timeoff_reguest_form"
viewobjectСобранный объект представления
{
  "title": "Уведомление об отпуске",
  "blocks": [
    {
      "type": "header",
      "text": "Основная информация"
    }
  ]
}

Параметры бота

ПараметрТипОписаниеПример
idinteger(int32)Идентификатор бота1738816
webhookobjectОбъект параметров вебхука
{
  "outgoing_url": "https://www.website.com/tasks/new"
}

Событие исходящего вебхука

ПараметрТипОписаниеПример
idstringИдентификатор события"01KAJZ2XDSS2S3DSW9EXJZ0TBV"
event_typestringТип события"message_new"
payloadWebhookPayloadUnionОбъект вебхука
{
  "type": "message",
  "id": 1245817,
  "event": "new",
  "entity_type": "discussion",
  "entity_id": 5678,
  "content": "Текст сообщения",
  "user_id": 2345,
  "created_at": "2025-05-15T14:30:00.000Z",
  "url": "https://pachca.com/chats/1245817/messages/5678",
  "chat_id": 9012,
  "webhook_timestamp": 1747574400
}
created_atstring(date-time)Дата и время создания события (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2025-05-15T14:30:00.000Z"

Событие аудита

ПараметрТипОписаниеПример
idstringУникальный идентификатор события"a1b2c3d4-5e6f-7g8h-9i10-j11k12l13m14"
created_atstring(date-time)Дата и время создания события (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ"2025-05-15T14:30:00.000Z"
event_keyAuditEventKeyКлюч типа события"user_login"
entity_idstringИдентификатор затронутой сущности"98765"
entity_typestringТип затронутой сущности"User"
actor_idstringИдентификатор пользователя, выполнившего действие"98765"
actor_typestringТип актора"User"
detailsAuditEventDetailsUnionДополнительные детали события. Структура зависит от значения event_key — см. описания значений поля event_key. Для событий без деталей возвращается пустой объект
ip_addressstringIP-адрес, с которого было выполнено действие"192.168.1.100"
user_agentstringUser agent клиента"Pachca/3.60.0 (co.staply.pachca; build:15; iOS 18.5.0) Alamofire/5.0.0"