Для: Администраторы
Поиск обращений и пользователей с помощью управляющего ключа.
Находите дела, людей, участников дела, роли и импортируйте строки по тексту с фильтрами из собственного программного обеспечения.
В этой статье6 разделов
Прежде чем начать
Эта страница описывает функцию GET https://prd-api-manage.caseactive.com/v1/<hub id>/search. Эта функция позволяет находить записи в вашем хабе по тексту. Она выполняет поиск только внутри вашего собственного хаба.
Параметры
| Параметр | Что это делает | Необходимый | По умолчанию |
|---|---|---|---|
table | Что следует проверять: cases, host_users, case_users, host_roles, case_invoices, host_imports или import_items | Да. | — |
query | Текст, который нужно найти: * соответствует всем элементам списка. Это позволяет проводить поиск только по фильтрам. | Да. | — |
query_by | Текстовые поля, которые необходимо проверить, разделены комами. Пример: given_name,family_name,email | Да. | — |
filter_by | Есть одно условие: например, case_status:=1. Необходимо повторять этот параметр для добавления ещё большего количества условий. Все условия должны выполняться. | Нет. | Ничего. |
sort_by | Числовое поле и направление, например: created_on:desc | Нет. | Лучший вариант |
page | Какой страницы? | Нет. | 1 |
limit | В одной странице может отображаться до 250 результатов. | Нет. | 10 |
- Слово в
queryсовпадает с начальной частью текста; допускается наличие одного-двух ошибок в написании. Следовательно,janможет найти слово “Jane”. В идентификаторах тегов, именах, адресах электронной почты, номерах телефонов и идентификаторах ссылок это слово также может находиться в любом месте текста. Следовательно,end-2026может найтиrear-end-2026. - Фильтр представляет собой поле, оператор и значение:
:=– точное значение,:!=– нечто другое, а для чисел используются значения:>,:<,:>=и:<=. Условие не может содержать значений типа&&,||, скобок или запятых. Вместо этого можно использовать несколько параметров видаfilter_by. Значение может содержать значения типа/и+; например,ref_id:=2026/rear-endилиphone:=+15551234567. В адресе используется значение+вместо%2B; в противном случае это значение будет интерпретироваться как пробел. - Могут сортироваться только числовые поля. Даты в результатах представлены в формате Unix-секунд.
- Чтобы запись появилась на сервере после её создания или изменения, может потребоваться несколько минут.
- Запросы нельзя искать с помощью ключа.
Таблицы
table | Текстовые поля для поиска и фильтрации. | Числовые поля для фильтрации и сортировки. |
|---|---|---|
cases | case_id, ref_id (Это…) ID теговИдентификатор метки Постоянная метка, которую вы присваиваете делу, например, rear-end-2026, также отображается в качестве идентификатора ссылки и используется при импорте.), title, description, case_type, case_stage, users (Удостоверения пользователей членов организации) | case_status (1 открытое, 0 закрытое) users_ct, date_opened, created_on, last_activity, updated_on |
host_users | user_id, given_name, family_name, email, phone, host_ref_id, title, company, address1, address2, locality, region, postal_code, country, gender, birthdate_md (месяц и день, например 04-12), locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designation | host_user_status (1 активно, 0 отключено), host_cases_ct, email_verified, phone_verified, created_on, updated_on |
case_users | case_id, user_id, case_ref_id, case_role_id, а также title и description. | case_status, created_on, updated_on |
host_roles | role_id, name, role_type, permissions, case_read_fields, case_write_fields | users_ct, created_on, updated_on |
case_invoices | invoice_id, name, invoice_number, po_number, host_ref_id, description, notes, status (open, paid, void, uncollectible или processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed или canceled), refund_reason, completed_on_day | total, subtotal, discount, tax, refund_amount, payment_attempts_ct, due_date, completed_on, created_on, updated_on |
host_imports | import_id, name, source, type, user_id, status | total, passed, failed, created_on, updated_on |
import_items | import_id, unique_id, type, status, error_msg, error_record | created_on, updated_on |
host_users Включает в себя вашу хаб-установку. Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника., Кого host_user_type есть bot. case_users Не имеет имени: нужно найти этого человека. host_users, Затем происходит фильтрация. case_users По- user_id. case_invoices Поддерживаются только опубликованные счета-фактуры. Их суммы указаны в центах. tax и discount Это дроби. Инвентарная расписка сохраняет свою силу. status paid; Возврат средств происходит в соответствии с установленными правилами. refund_status.
Примеры
Дело по номеру его тегов:
curl -G https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/search \
-H "Authorization: Bearer YOUR_API_KEY" \
--data-urlencode "table=cases" \
--data-urlencode "query=*" \
--data-urlencode "query_by=ref_id" \
--data-urlencode "filter_by=ref_id:=rear-end-2026"
Активные люди, чьи имена или адреса электронной почты начинаются с символа jane. Порядок отсортирования по возрасту: наиболее молодые первыми.
curl -G https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/search \
-H "Authorization: Bearer YOUR_API_KEY" \
--data-urlencode "table=host_users" \
--data-urlencode "query=jane" \
--data-urlencode "query_by=given_name,family_name,email" \
--data-urlencode "filter_by=host_user_status:=1" \
--data-urlencode "sort_by=created_on:desc"
Открывайте дела в одно время. этап/фазаЭтап Этап, через который проходит дело, например, прием заявки или отправка запроса, который фирма обозначает и описывает и который отображается на странице дела., Используя… stage_id из GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.
Инвойи были изменены с момента полуночи 8 октября 2026 года по UTC. Самые старые изменения указаны первыми: table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc.
Результаты
{
"data": {
"found": 1,
"page": 1,
"hits": [
{
"document": {
"case_id": "cc-1a2b3c4d5e6f70",
"host_id": "ca-7e6d5c4b3a2f10",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_type": "general",
"case_status": 1,
"users": ["cu-4f1c2a9e8b7d60", "cu-9d8c7b6a5f4e30"],
"users_ct": 2,
"date_opened": 1790899200,
"created_on": 1790949909,
"updated_on": 1790949909
}
}
]
}
}
found Сколько записей совпадают. Каждый результат поиска… document Это запись; также имеются свои поля для оценки, которые можно игнорировать. Никаких других данных нет. nextLink: Просите о следующем. page Пока вы не получите его. found Результаты.
Поиск по слову также может выявить схожие значения. Поэтому, когда вы ищете информацию о каком-либо записи по её идентификатору, необходимо проверить все соответствующие данные. document Вы возвращаетесь назад.
Если звонок отклонен
| Статус | message | Почему |
|---|---|---|
| 400 | SchemaFieldsException | Значения table, query или query_by отсутствуют или неизвестны. Кроме того, значение filter_by содержит символы, которые не могут быть использованы в данном контексте (FieldSearchFilterTypeException, на позиции filter_by.0 для первого случая). |
| 400 | SearchParameterException | Сервис поиска отказался обработать этот запрос: неизвестные поля, фильтры, которые сервис не может распознать, текстовые поля в формате sort_by или limit с объемом более 250 символов. Поле reason содержит слова, созданные самим сервисом поиска. |
| 403 | BotSearchTableNotAllowedException | Вы попросили host_inquiries, но ключ не может найти это значение. |
| 500 | InternalError | Сервис поиска информации не работает. Попробуйте снова позже. |