Resources en live schema’s

Ontdekken in plaats van raden#

Roep /resources aan voor de catalogus van je sleutel, vervolgens /resources/{resource} voor de actuele veldbeschrijving en relaties. De beschrijving bevat schrijfbare velden, verplichte velden, opties en beschikbare sorteer- en filterkeys. Het is geen volledige lijst van alle leesbare of beheerde antwoordvelden. Een catalogusitem geeft geen toegang tot elk record.

• CRM-resources zijn onder meer companies, contacts, deals, leads, products en activities.
• Leveringsresources zijn onder meer projects, project_tasks en de projectreferentiecatalogi.
• Werkruimtevocabulaire omvat pipelines, fasen, tags, afdelingen en andere resourcespecifieke catalogi.
• entity_members, automations en project_approvals zijn alleen leesbaar.
• De volledige lijst en alle ondersteunde operaties staan in de endpointreferentie.

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"

De veldkeys van de werkruimte gebruiken#

Aangepaste velden en keuzewaarden verschillen per werkruimte. Lees de beschrijving voordat je een payload bouwt. Filteren op een aangepast veld gebruikt de filter_key, meestal cfv:<definition-id>; schrijven gebruikt cf__<key> of een custom_fields-object per veldkey. Dit zijn verschillende identificaties. Formulevelden en andere alleen-lezenvelden zijn niet schrijfbaar.

Records van aangepaste datamodellen#

data_model_records ontsluit records van een aangepast datamodel, ook modellen achter formulieren. Haal de model-UUID op in de modelinstellingen van de app of via de MCP-tool list_data_models. Er is geen REST-endpoint /data_models om modellen te ontdekken.

• Stuur model_id mee bij beschrijven of opvragen van modellijsten, ook bij POST /query.
• Stuur model_id mee bij aanmaken of bijwerken, in de vlakke body of querystring.
• Het live modelschema bepaalt de schrijfbare en verplichte velden.
• Bewaar de modelidentificatie in je integratieconfiguratie; leid die niet af van een record-ID.

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"

Velden selecteren met behoud van rechten#

Gebruik fields=name,domain op een lijst of record-GET, of fields: ["name", "domain"] in een querybody. id blijft behouden. Namen die niet in het antwoordrecord staan worden overgeslagen. Veldselectie verkleint het antwoord, niet het databasewerk. Beperkte velden blijven gemaskeerd of afwezig volgens de resourceprojectie.

Een contract dat je configuratie volgt#

Gebruik de OpenAPI-referentie voor routes en transportschema’s en de geauthenticeerde beschrijving voor actuele werkruimtevelden. De statische referentie kan je aangepaste velden of de huidige rechten van elke rol niet kennen.