HilfezentrumIntegrationen

Für: Administratoren

Suchen Sie Fälle und Benutzer mit einem Verwaltungsschlüssel.

Suchen Sie nach Fällen, Personen, Fallbeteiligten, Rollen und importieren Sie Zeilen anhand von Text, mit Filtern, aus Ihrer eigenen Software.

In diesem Artikel6 Abschnitte

Bevor Sie beginnen

Diese Seite behandelt die Funktion GET https://prd-api-manage.caseactive.com/v1/<hub id>/search. Diese Funktion sucht in Ihrem Hub nach Einträgen, die mit bestimmten Texten übereinstimmen. Dabei wird ausschließlich in Ihrem eigenen Hub gesucht.

Parameter

ParameterWas es tutErforderlichStandard
tableWas gesucht werden soll: cases, host_users, case_users, host_roles, case_invoices, host_imports oder import_itemsJa.–
queryDer Text, den man suchen soll: * passt zu allem – bei einer Suche allein nach Filterkriterien.Ja.–
query_byDie Textfelder, die besucht werden sollen, sind durch Kommas getrennt. Beispiel: given_name,family_name,emailJa.–
filter_byEine Bedingung, wie zum Beispiel case_status:=1. Die Parameter sollten wiederholt werden, um mehr zu hinzufügen – alle Bedingungen müssen erfüllt werden.Nein.Keine.
sort_byEine Zahlenfeld und eine Richtung, wie zum Beispiel created_on:descNein.Beste Übereinstimmung
pageWelche Seite?Nein.1
limitDie Anzahl der Ergebnisse, die auf einer Seite angezeigt werden können, beträgt bis zu 250.Nein.10
  • Ein Wort in query passt von Anfang an zum Text. Es ist auch möglich, dass es ein oder zwei Fehler im Text vorkommen – daher passt jan zu „Jane“. In Tag-IDs, Namen, E-Mail-Adressen, Telefonnummern und Referenz-IDs kann das Wort auch an beliebigen Stellen im Text verwendet werden. Somit passt end-2026 zu rear-end-2026.
  • Ein Filter besteht aus einem Feld, einem Operator und einem Wert: := bedeutet „exakt“, :!= bedeutet „nicht“. Für Zahlen werden die Werte :>, :<, :>= und :<= verwendet. Eine Bedingung darf keine &&-, ||- oder Komma-Zeichen enthalten – stattdessen sollten mehrere filter_by-Parameter gesendet werden. Ein Wert kann / und + enthalten; beispielsweise ref_id:=2026/rear-end oder phone:=+15551234567. In einer Adresse sollte + als %2B gesendet werden – ansonsten wird es als Leerzeichen interpretiert.
  • Nur Zahlenfelder können sortiert werden. Die Daten in den Ergebnissen werden in Unix-Sekunden angegeben.
  • Es kann einige Minuten dauern, bis eine erstellte oder geänderte Datei angezeigt wird.
  • Fragen können nicht mit einem Schlüssel gesucht werden.

Tabellen

tableTextfelder zum Suchen und FilternZahlenfelder zum Filtern und Sortieren
casescase_id, ref_id (die Tag-IDTag-ID Eine permanente Bezeichnung, die Sie einem Fall geben, z. B. rear-end-2026, die auch als Referenz-ID angezeigt und bei Importen verwendet wird.), title, description, case_type, case_stage, users (BenutzerIDs der Mitglieder)case_status )1 Offen, 0 geschlossen) users_ct, date_opened, created_on, last_activity, updated_on
host_usersuser_id, given_name, family_name, email, phone, host_ref_id, title, company, address1, address2, locality, region, postal_code, country, gender, birthdate_md (Monat und Tag, beispielsweise 04-12), locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designationhost_user_status (1 aktiv, 0 deaktiviert), host_cases_ct, email_verified, phone_verified, created_on, updated_on
case_userscase_id, user_id, case_ref_id, case_role_id sowie die Werte von title und descriptioncase_status, created_on, updated_on
host_rolesrole_id, name, role_type, permissions, case_read_fields, case_write_fieldsusers_ct, created_on, updated_on
case_invoicesinvoice_id, name, invoice_number, po_number, host_ref_id, description, notes, status (open, paid, void, uncollectible oder processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed oder canceled), refund_reason, completed_on_daytotal, subtotal, discount, tax, refund_amount, payment_attempts_ct, due_date, completed_on, created_on, updated_on
host_importsimport_id, name, source, type, user_id, statustotal, passed, failed, created_on, updated_on
import_itemsimport_id, unique_id, type, status, error_msg, error_recordcreated_on, updated_on

host_users Inkludiert Ihren Hub. Virtuelle Assistentin/Virtueller AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen., Wessen? host_user_type ist bot. case_users Es gibt keine Namen. Finden Sie die Person. host_users, Dann filtern. case_users von/aus user_id. case_invoices Es werden nur veröffentlichte Rechnungen verwendet. Die Beträge sind in Cent angegeben. tax Und… discount Es handelt sich dabei um Brüche. Eine zurückerstattete Rechnung behält also ihre Gültigkeit. status paid; Die Rückerstattung erfolgt auf diese Weise. refund_status.

Beispiele

Ein Fall anhand seiner Tag-ID:

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"

Aktive Personen, deren Name oder E-Mail-Adresse mit jane beginnt – sortiert nach dem Datum des letzten Kontakts:

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"

Öffnen Sie die Fälle in einem bestimmten StadiumBühne Ein Verfahrensschritt, den ein Fall durchläuft, wie z. B. die Aufnahme oder das Versenden der Aufforderung, der von der Kanzlei benannt und beschrieben wird und auf der Fallseite angezeigt wird., unter Verwendung eines stage_id aus GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.

Die Rechnungen wurden seit Mitternacht des 8. Oktober 2026 um UTC geändert. Die ältesten Änderungen werden zuerst berücksichtigt: table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc

Ergebnisse

{
  "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 gibt an, wie viele Datensätze übereinstimmen. Der Wert von document bezeichnet jeweils einen Datensatz. Die Ergebnisse enthalten außerdem die Bewertungsfelder des Suchmaschinenbetreibers – diese können ignoriert werden. Es gibt kein nextLink- Feld. Man muss also weiterhin nach dem nächsten page suchen, bis man alle found Ergebnisse erhalten hat.

Eine Wörtersuche kann auch ähnliche Werte finden. Deshalb sollten Sie beim Suchen eines Datensatzes nach einer bestimmten ID auch die anderen Daten berücksichtigen. document Du bekommst dein Geld zurück.

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptiontable, query oder query_by fehlen oder sind unbekannt. Außerdem kann ein filter_by nur Zeichen enthalten, die es nicht kann (FieldSearchFilterTypeException, bei filter_by.0 zum ersten Mal).
400SearchParameterExceptionDas Suchmotorwerk weigerte sich, es zu verarbeiten: Es handelte sich um ein unbekanntes Feld, ein Filter, den das System nicht verstehen konnte. Zudem war es auch ein Textfeld. sort_by, Oder limit Über 250. reason Hält die eigenen Worte des Motors fest.
403BotSearchTableNotAllowedExceptionSie haben host_inquiries angefordert – doch eine Schlüssel kann solche Werte nicht suchen.
500InternalErrorDas Suchmotorgerät ist nicht funktionsfähig. Versuchen Sie es später noch einmal.

Verwandte Artikel

Fälle mit einem Verwaltungsschlüssel erstellen und aktualisierenSie können die Fälle Ihres Hubs in Ihrer eigenen Software auflisten, erstellen, lesen, aktualisieren und löschen, einschließlich ihrer Phase und benutzerdefinierten Felder.IntegrationenBenutzer mit einem Verwaltungsschlüssel hinzufügen und aktualisierenErstellen Sie eine Liste der Mitarbeiter Ihres Hubs, fügen Sie Kunden hinzu, lesen Sie die Details und Fälle einzelner Personen und deaktivieren oder aktivieren Sie deren Zugriff.Integrationen