EntwicklerdokumentationAPI v1

Anleitungen

Beziehungen zwischen Datensätzen

Verknüpfen Sie Unternehmen, Kontakte, Deals, Projekte und Tags mit denselben Beziehungsregeln wie in der App.

Die andere Seite entdecken

Eine Beziehung ist nach der Zielressource benannt. Lesen Sie /resources/{resource} und prüfen Sie associations vor dem Verknüpfen. Die Ressourcenliste des Schlüssels muss Quelle und Ziel enthalten, und der Eigentümer muss auf beide Datensätze zugreifen dürfen.

Die andere Seite entdecken
RessourcenRichtungBeziehungsfelder
companies / contactsBeide RichtungenBeschäftigungsrolle, Flags, Daten und Notizen.
deals / contactsBeide Richtungenrole, is_primary.
projects / dealsBeide RichtungenKeine schreibbaren Beziehungsfelder.
Unternehmen, Kontakte, Deals, Leads, Aktivitäten, Produkte → tagsNur zu TagsKeine schreibbaren Felder; für Rückwärtssuche einen tag_ids-Filter nutzen.

Lesen, verknüpfen und lösen

GET /{resource}/{id}/{association} listet Beziehungen. PUT /{resource}/{id}/{association}/{target_id} erstellt oder aktualisiert mit optionalem Objekt von Beziehungsfeldern. Erstellung liefert 201; eine bestehende Beziehung 200. DELETE auf demselben Zielpfad entfernt die Beziehung, akzeptiert keinen Anfragekörper und liefert 404, wenn sie nicht existierte. PUT und DELETE unterstützen Idempotency-Key.

Eine Beziehung erstellen oder ändern
read -r -p 'Company id: ' COMPANY_ID
read -r -p 'Contact id: ' CONTACT_ID
read -r -p 'Unique link operation key: ' LINK_KEY
curl --fail-with-body --request PUT "$SQUARIO_API_BASE/companies/$COMPANY_ID/contacts/$CONTACT_ID" \
  --header "Authorization: Bearer $SQUARIO_API_KEY" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $LINK_KEY" \
  --data '{"job_title":"Operations lead","is_primary":true}'
Eine Beziehung lesen und entfernen
curl --fail-with-body "$SQUARIO_API_BASE/companies/$COMPANY_ID/contacts" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

read -r -p 'Unique unlink operation key: ' UNLINK_KEY
curl --fail-with-body --request DELETE "$SQUARIO_API_BASE/companies/$COMPANY_ID/contacts/$CONTACT_ID" \
  --header "Authorization: Bearer $SQUARIO_API_KEY" \
  --header "Idempotency-Key: $UNLINK_KEY"

Beschäftigung hat eigene Regeln

Unternehmens-/Kontaktbeziehungen akzeptieren job_title, department, role_label, role_description, decision_power, buying_role, is_primary, is_decision_maker, is_billing_contact, is_technical_contact, started_at und notes. Typen und Optionen stehen in der Referenz.

  • Eine neue Beziehung hat standardmäßig is_primary: false. Eine primäre Beziehung löst das bisherige primäre Unternehmen des Kontakts ab.
  • Ohne is_primary bleibt der Wert einer bestehenden Beziehung erhalten.
  • DELETE beendet die Beschäftigung zum heutigen Datum und entfernt das Primärflag. Beendete Beziehungen verschwinden aus der Liste.
  • Lösen des primären Projekt-Deals ergibt 409; ändern Sie zuerst die primäre Beziehung in der App.

Jede Beziehung enthält die beiden Datensatzkennungen, erlaubte Beziehungsfelder und Zeitstempel, ohne eigene Kennung, Autor oder interne Metadaten der Verbindungstabelle. Listen enthalten data und meta: { page, page_size, has_more }, älteste zuerst, ohne Gesamtanzahl. Beziehungsseiten verwenden standardmäßig 100 und akzeptieren 1–100. Maskierte Felder sind null, auch boolesche Flags; boolesche PUT-Felder verlangen weiterhin einen Boolean.