Pour: Administrateurs
Rechercher les dossiers et les utilisateurs avec une clé de gestion
Trouvez des dossiers, des personnes, des membres de dossiers, des rôles et importez des lignes par texte, avec des filtres, à partir de votre propre logiciel.
Dans cet article6 sections
Avant de commencer
Cette page traite de l’outil GET https://prd-api-manage.caseactive.com/v1/<hub id>/search, qui permet de trouver des informations dans votre hub en fonction du texte. Ce outil ne recherche que dans votre propre hub.
Paramètres
| Paramètre | Ce que cela fait | Requis | Défaut |
|---|---|---|---|
table | Qu’il s’agisse de rechercher : cases, host_users, case_users, host_roles, case_invoices, host_imports ou import_items. | Oui. | — |
query | Le texte à trouver : * correspond à tout ce qui est pertinent, pour une recherche basée uniquement sur les filtres. | Oui. | — |
query_by | Les champs de texte à examiner, séparés par des virgules, par exemple : given_name,family_name,email | Oui. | — |
filter_by | Une condition, comme case_status:=1. Il est possible de répéter ce paramètre pour ajouter davantage de conditions ; toutes doivent être respectées. | Non. | Aucun. |
sort_by | Un champ numérique et une direction, comme created_on:desc | Non. | Meilleur choix possible |
page | Quelle page ? | Non. | 1 |
limit | Les résultats affichés sur une page peuvent aller jusqu’à 250 éléments. | Non. | 10 |
- Une chaîne de caractères commençant par
querycorrespond à cette chaîne de caractères. Il est possible qu’il y ait quelques erreurs de frappe, mais cela ne pose pas de problème. Ainsi,janpermet de trouver “Jane”. Dans les identifiants de balises, les noms, adresses e-mail, numéros de téléphone et identifiants de référence, cette règle s’applique également partout dans le texte. Donc,end-2026correspond àrear-end-2026. - Un filtre est un champ, un opérateur et une valeur :
:=pour les valeurs exactes,:!=pour les valeurs négatives, et:>,:<,:>=et:<=pour les nombres. Une condition ne peut pas contenir des éléments comme&&,||, des crochets ou des virgules. Il est préférable d’utiliser plusieurs paramètres de typefilter_byà la place. Une valeur peut contenir des éléments comme/et+, par exempleref_id:=2026/rear-endouphone:=+15551234567. Dans une adresse, il est possible d’envoyer+en tant que%2B; sinon, cette valeur sera représentée par un espace. - Seuls les champs numériques peuvent être triés. Les dates présentées dans les résultats sont exprimées en secondes Unix.
- Il peut falloir quelques minutes pour que le enregistrement apparaisse après sa création ou sa modification.
- Les recherches ne peuvent pas être effectuées en utilisant une clé.
Tables
table | Champs de texte pour rechercher et filtrer | Champs numériques, pour filtrer et trier |
|---|---|---|
cases | case_id, ref_id (le) ID de l’élémentID de l'étiquette Une étiquette permanente que vous attribuez à un boîtier, telle que rear-end-2026, également appelée ID de référence et utilisée dans les importations.), title, description, case_type, case_stage, users (ID des utilisateurs des membres) | case_status )1 Ouvré, 0 Fermé). 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 (mois et jour, par exemple 04-12), locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designation | host_user_status (1 activé, 0 désactivé), host_cases_ct, email_verified, phone_verified, created_on, updated_on |
case_users | case_id, user_id, case_ref_id, case_role_id, ainsi que les valeurs de title et description dans ce cas. | 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 ou processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed ou 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 Inclut votre hub. Assistante virtuelleAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel., de qui host_user_type C’est. bot. case_users Ne conserve aucun nom : trouvez la personne correspondante. host_users, Ensuite, filtrez le contenu. case_users par user_id. case_invoices Il ne conserve que les factures publiées. Les montants indiqués sont exprimés en centimes. tax Et… discount Ce sont des fractions. Une facture réimboursée conserve donc son valeur initiale. status paid; Son remboursement se fait donc dans ce cadre. refund_status.
Exemples
Un cas, en fonction de son identifiant Tag :
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"
Personnes actives dont le nom ou l’adresse e-mail commence par jane. Les personnes les plus récentes sont listées en premier :
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"
Ouvrir les dossiers en un seul geste. ÉtapeScène Une étape du traitement d'un dossier, telle que la prise en charge ou l'envoi d'une demande, que le cabinet nomme et décrit et qui apparaît sur la page du dossier., En utilisant… stage_id De GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.
Les factures ont été modifiées à partir de minuit du 8 octobre 2026, selon le fuseau horaire UTC. Les modifications les plus anciennes sont affichées en premier : table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc.
Résultats
{
"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 indique le nombre de records qui correspondent à la recherche. Le document correspond au record concerné. Les résultats fournis par le moteur de recherche contiennent également des informations de notation ; vous pouvez ignorer ces informations. Il n’y a pas de nextLink : il suffit d’attendre le prochain page jusqu’à ce que vous obteniez found résultats.
La recherche par mots peut également permettre de trouver des valeurs similaires. Ainsi, lorsque vous recherchez un enregistrement en utilisant une ID donnée, vérifiez le résultat obtenu sous document.
Si un appel est refusé
| Statut | message | Pourquoi |
|---|---|---|
| 400 | SchemaFieldsException | table, query ou query_by manquent ou sont inconnus. De plus, un filter_by contient des caractères qu’il ne peut pas gérer. (FieldSearchFilterTypeException, à la position filter_by.0 pour le premier cas.) |
| 400 | SearchParameterException | Le moteur de recherche l’a refusé : il s’agit d’un champ inconnu, un filtre qu’il ne peut pas lire. Il s’agit également d’un champ de texte. sort_by, Ou limit Plus de 250. reason Il retient les mots prononcés par le moteur lui-même. |
| 403 | BotSearchTableNotAllowedException | Vous avez demandé host_inquiries, mais une clé ne peut pas rechercher ce élément. |
| 500 | InternalError | Le moteur de recherche est indisponible pour l’instant. Veuillez réessayer plus tard. |