Ressourcen und aktuelle Schemas

Entdecken statt raten#

Rufen Sie /resources für den Katalog Ihres Schlüssels auf, dann /resources/{resource} für aktuelle Felder und Beziehungen. Die Beschreibung enthält das Schema schreibbarer Felder, Pflichtfelder, Optionen und verfügbare Sortier- und Filterschlüssel. Sie listet nicht jedes lesbare oder verwaltete Antwortfeld auf. Ein Katalogeintrag gewährt keinen Zugriff auf jeden Datensatz.

• CRM-Ressourcen umfassen companies, contacts, deals, leads, products und activities.
• Delivery-Ressourcen umfassen projects, project_tasks und die Referenzkataloge für Projekte.
• Arbeitsbereichsvokabular umfasst Pipelines, Phasen, Tags, Abteilungen und weitere ressourcenspezifische Kataloge.
• entity_members, automations und project_approvals sind nur lesbar.
• Die vollständige Liste und alle unterstützten Operationen stehen in der Endpointreferenz.

curl --fail-with-body "$SQUARIO_API_BASE/resources" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

curl --fail-with-body "$SQUARIO_API_BASE/resources/companies" \
  --header "Authorization: Bearer $SQUARIO_API_KEY"

Feldschlüssel des Arbeitsbereichs nutzen#

Benutzerdefinierte Felder und Optionswerte unterscheiden sich je Arbeitsbereich. Lesen Sie die Beschreibung vor dem Payload. Filtern verwendet den filter_key, meist cfv:<definition-id>; Schreiben verwendet cf__<key> oder ein custom_fields-Objekt nach Feldschlüssel. Das sind unterschiedliche Kennungen. Formel- und andere schreibgeschützte Felder sind nicht änderbar.

Datensätze benutzerdefinierter Modelle#

data_model_records erschließt Datensätze eines benutzerdefinierten Datenmodells, einschließlich formulargebundener Modelle. Holen Sie die Modell-UUID aus den Modelleinstellungen der App oder dem MCP-Tool list_data_models. Es gibt keinen REST-Discovery-Endpoint /data_models.

• Geben Sie model_id beim Beschreiben oder Auflisten an, auch bei POST /query.
• Geben Sie model_id beim Erstellen oder Aktualisieren im flachen Anfragekörper oder der Querystring an.
• Das aktuelle Modellschema bestimmt schreibbare und erforderliche Felder.
• Speichern Sie die Modellkennung in der Integrationskonfiguration; leiten Sie sie nicht aus einer Datensatzkennung ab.

read -r -p 'Data model id from Squario: ' MODEL_ID
curl --fail-with-body --get "$SQUARIO_API_BASE/data_model_records" \
  --header "Authorization: Bearer $SQUARIO_API_KEY" \
  --data-urlencode "model_id=$MODEL_ID" \
  --data-urlencode 'page_size=25'

curl --fail-with-body --get "$SQUARIO_API_BASE/resources/data_model_records" \
  --header "Authorization: Bearer $SQUARIO_API_KEY" \
  --data-urlencode "model_id=$MODEL_ID"

Felder unter Wahrung der Rechte auswählen#

Verwenden Sie fields=name,domain bei einer Liste oder einem Datensatz-GET, oder fields: ["name", "domain"] im Query-Anfragekörper. id bleibt erhalten. Nicht vorhandene Namen werden übersprungen. Die Auswahl reduziert die Antwortgröße, nicht die Datenbankarbeit. Eingeschränkte Felder bleiben entsprechend der Ressourcenprojektion maskiert oder fehlen.

Ein Vertrag passend zur Konfiguration#

Verwenden Sie die OpenAPI-Referenz für Routen und Transportschemas und die authentifizierte Beschreibung für aktuelle Arbeitsbereichsfelder. Die statische Referenz kennt weder Ihre benutzerdefinierten Felder noch die aktuellen Berechtigungen jeder Rolle.