Ressources et schémas en ligne

Découvrir plutôt que deviner#

Appelez /resources pour le catalogue disponible à votre clé, puis /resources/{resource} pour les champs et associations de l’espace de travail. La description expose le schéma des champs modifiables, les champs obligatoires, les options et les clés disponibles pour trier et filtrer. Elle ne liste pas tous les champs lisibles ou gérés présents dans les réponses. Une entrée du catalogue ne donne pas accès à toutes les fiches.

• Les ressources CRM incluent companies, contacts, deals, leads, products et activities.
• Les ressources de livraison incluent projects, project_tasks et les catalogues de référence des projets.
• Le vocabulaire de l’espace inclut les pipelines, étapes, tags, départements et autres catalogues propres aux ressources.
• entity_members, automations et project_approvals sont en lecture seule.
• La référence des endpoints contient toutes les ressources et leurs opérations disponibles.

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"

Utiliser les clés de champs de l’espace#

Les champs personnalisés et leurs options varient selon l’espace de travail. Lisez la description avant de construire un payload. Le filtre d’un champ personnalisé utilise son filter_key, généralement cfv:<definition-id> ; l’écriture utilise cf__<key> ou un objet custom_fields indexé par clé de champ. Ces identifiants sont différents. Les champs de formule et autres champs en lecture seule ne sont pas modifiables.

Fiches des modèles de données#

data_model_records expose les fiches d’un modèle de données personnalisé, y compris celles des modèles liés aux formulaires. Récupérez l’UUID du modèle dans ses paramètres dans l’application ou avec l’outil MCP list_data_models. Il n’existe pas d’endpoint REST de découverte /data_models.

• Fournissez model_id pour décrire ou lister les fiches, y compris avec POST /query.
• Fournissez model_id lors d’une création ou modification, dans le corps JSON plat ou dans la chaîne de requête.
• Le schéma actuel du modèle détermine ses champs modifiables et obligatoires.
• Conservez l’identifiant du modèle dans la configuration de votre intégration ; ne le déduisez pas d’un identifiant de fiche.

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"

Sélectionner des champs sans contourner les permissions#

Utilisez fields=name,domain pour une liste ou un GET de fiche, ou un tableau fields dans le corps d’une requête POST /query. id est conservé. Les noms absents de la fiche renvoyée sont ignorés. Cette sélection réduit la taille de la réponse, pas le travail de la base de données. Les champs restreints restent masqués ou absents selon la projection de la ressource.

Un contrat qui suit votre configuration#

Utilisez la référence OpenAPI pour les routes et schémas de transport, et la description authentifiée pour les champs actuels de votre espace de travail. La référence statique ne peut pas connaître vos champs personnalisés ni les permissions actuelles de chaque rôle.