Para: Administradores
Buscar casos y usuarios con una clave de administración
Encuentre casos, personas, miembros de casos, roles e importe filas por texto, con filtros, desde su propio software.
En este artículo6 secciones
Antes de empezar
Esta página se refiere a GET https://prd-api-manage.caseactive.com/v1/<hub id>/search, que busca registros en tu hub, basándose en texto. Solo realiza búsquedas dentro de tu propio hub.
Parámetros
| Parámetro | Lo que hace | Requerido | Por defecto |
|---|---|---|---|
table | Qué buscar: cases, host_users, case_users, host_roles, case_invoices, host_imports o import_items | Sí. | — |
query | El texto que se debe buscar: * coincide con todo, ya sea para una búsqueda basada únicamente en los filtros. | Sí. | — |
query_by | Los campos de texto que se deben ver, separados por comas, como given_name,family_name,email | Sí. | — |
filter_by | Una condición, como case_status:=1. Se puede repetir el parámetro para agregar más condiciones; todas deben cumplirse. | No. | Ninguno. |
sort_by | Un campo numérico y una dirección, como created_on:desc | No. | Mejor coincidencia |
page | ¿Qué página? | No. | 1 |
limit | Los resultados que se muestran en una página pueden ser hasta 250. | No. | 10 |
- Una palabra en
querycoincide desde su inicio; además, se permite un error de ortografía o dos. Por lo tanto,janencuentra “Jane”. En los ID de etiquetas, nombres, direcciones de correo electrónico, números de teléfono y IDs de referencia, también se puede encontrar esa palabra en cualquier lugar dentro del texto. Así,end-2026encuentrarear-end-2026. - Un filtro consiste en un campo, un operador y un valor:
:=para “exacto”,:!=para “no”, y:>,:<,:>=y:<=para números. Una condición no puede contener&&,||, paréntesis ni comas. En lugar de eso, se deben enviar varios parámetrosfilter_by. Un valor puede contener/y+, comoref_id:=2026/rear-endophone:=+15551234567. En una dirección, se debe enviar+como%2B; de lo contrario, el resultado será un espacio. - Solo los campos numéricos pueden ser ordenados. Las fechas que aparecen en los resultados están expresadas en segundos de formato Unix.
- Puede take algunos minutos para que un registro aparezca, después de que se crea o se modifica.
- Las consultas no pueden ser buscadas utilizando una clave.
Tablas
table | Campos de texto, para buscar y filtrar | Campos numéricos para filtrar y ordenar. |
|---|---|---|
cases | case_id, ref_id (the ID de etiquetaID de etiqueta Una etiqueta permanente que se le asigna a una caja, como por ejemplo rear-end-2026, que también se muestra como ID de referencia y se utiliza en las importaciones.), title, description, case_type, case_stage, users (IDs de usuario de los miembros) | case_status (1 abierto, 0 Cerrado). 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 (mes y día, por ejemplo 04-12), locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designation | host_user_status (1 activo, 0 desactivado), host_cases_ct, email_verified, phone_verified, created_on, updated_on |
case_users | case_id, user_id, case_ref_id, case_role_id, y también los valores de title y description del caso en cuestión. | 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 o processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed o 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 incluye al Asistente VirtualAsistente virtual Un miembro del equipo automatizado que publica mensajes de bienvenida, registros de asistencia y actualizaciones de la empresa; sus publicaciones llevan una insignia de Asistente Virtual. de tu centro de control. Su host_user_type es bot. case_users no contiene ningún nombre. Para encontrar a esa persona, utiliza host_users. Luego, filtra los resultados con case_users y user_id. case_invoices solo contiene facturas publicadas. Los montos de las facturas están expresados en centésimas, y tax y discount son fracciones. Una factura reembolsada conserva los valores de status y paid; el reembolso se indica en refund_status.
Ejemplos
Un caso, según su ID de etiquetado:
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"
Personas activas cuyos nombres o correos electrónicos comienzan con jane. Ordenados por orden de llegada:
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"
Se pueden abrir casos en una sola etapaEscenario Una etapa por la que pasa un caso, como la recepción o el envío de la solicitud, que la firma nombra y describe y que se muestra en la página del caso., utilizando un stage_id proveniente de GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.
Las facturas han cambiado desde la medianoche del 8 de octubre de 2026, según el horario UTC. Los cambios más antiguos aparecen primero: table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc.
Resultados
{
"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 indica cuántos registros coinciden con la búsqueda realizada. El document de cada registro es el resultado de la búsqueda; además, los registros también contienen los campos de puntuación asignados por el motor de búsqueda, los cuales pueden ignorarse. No existe un nextLink: se debe pedir el siguiente page hasta que se obtengan todos los found resultados.
La búsqueda por palabras también puede encontrar valores similares. Por lo tanto, cuando buscas un registro según su ID, debes verificar el resultado que obtienes, es decir, los valores que aparecen en document.
Si se rechaza una llamada
| Estado | message | Por qué |
|---|---|---|
| 400 | SchemaFieldsException | table, query o query_by no están disponibles o son desconocidos. Además, filter_by contiene caracteres que no pueden ser procesados. (FieldSearchFilterTypeException, en filter_by.0 para el primer caso.) |
| 400 | SearchParameterException | El motor de búsqueda lo rechazó: se trataba de un campo desconocido, un filtro que no podía ser leído, o bien un campo de texto en sort_by. Además, el valor de limit superaba los 250 caracteres. reason contenía las palabras propias del motor de búsqueda. |
| 403 | BotSearchTableNotAllowedException | Usted solicitó host_inquiries, pero una clave no puede buscar algo así. |
| 500 | InternalError | El motor de búsqueda está desactivado. Intente nuevamente más tarde. |