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

Список чатов

GET/chats
chats:read

Метод для получения списка чатов по заданным параметрам.

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

sort[{field}]
string
Составной параметр сортировки сущностей выборки
Возможные параметры и значения
По умолчанию:
sort[id]=desc
availability
string
Параметр, который отвечает за доступность и выборку чатов для пользователя
Возможные значения
Пример:is_member
По умолчанию:
is_member
last_message_at_after
string, (date-time)
Фильтрация по времени создания последнего сообщения. Будут возвращены те чаты, время последнего созданного сообщения в которых не раньше чем указанное (в формате YYYY-MM-DDThh:mm:ss.sssZ).
Пример:2025-01-01T00:00:00.000Z
last_message_at_before
string, (date-time)
Фильтрация по времени создания последнего сообщения. Будут возвращены те чаты, время последнего созданного сообщения в которых не позже чем указанное (в формате YYYY-MM-DDThh:mm:ss.sssZ).
Пример:2025-02-01T00:00:00.000Z
personal
boolean
Фильтрация по личным и групповым чатам. Если параметр не указан, возвращаются любые чаты.
Пример:false
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)
*
Идентификатор созданного чата
Пример:334
name
string
*
Название
Пример:🤿 aqua
created_at
string, (date-time)
*
Дата и время создания чата (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:56:53.000Z
owner_id
integer, (int32)
*
Идентификатор пользователя, создавшего чат
Пример:185
member_ids[]
array of integers, (int32)
*
Массив идентификаторов пользователей, участников
Пример:[185,186,187]
group_tag_ids[]
array of integers, (int32)
*
Массив идентификаторов тегов, участников
Пример:[9111]
channel
boolean
*
Является каналом
Пример:true
personal
boolean
*
Является личным чатом
Пример:false
public
boolean
*
Открытый доступ
Пример:false
last_message_at
string, (date-time)
*
Дата и время создания последнего сообщения в чате (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:56:53.000Z
meet_room_url
string
*
Ссылка на Видеочат
Пример:https://meet.pachca.com/aqua-94bb21b5
meta
object
Метаданные пагинации
paginate
object
Вспомогательная информация
next_page
string
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
Список чатов
# Для получения следующей страницы используйте cursor из meta.paginate.next_pagecurl "https://api.pachca.com/api/shared/v1/chats?sort[id]=desc&availability=is_member&last_message_at_after=2025-01-01T00:00:00.000Z&last_message_at_before=2025-02-01T00:00:00.000Z&personal=false&limit=1" \  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Ответ 200
{  "data": [    {      "id": 334,      "name": "🤿 aqua",      "created_at": "2021-08-28T15:56:53.000Z",      "owner_id": 185,      "member_ids": [        185,        186,        187      ],      "group_tag_ids": [        9111      ],      "channel": true,      "personal": false,      "public": false,      "last_message_at": "2021-08-28T15:56:53.000Z",      "meet_room_url": "https://meet.pachca.com/aqua-94bb21b5"    }  ],  "meta": {    "paginate": {      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3"    }  }}