Get Service Schema
get_schemaFetches the schema of all resource types, including attributes and relationships, to guide API requests for creating, updating, filtering, and including related records.
Instructions
Schema of every resource type exposed by this Connhex JSON:API service for the current deployment.
Shape:
Top-level keys are resource type names. Use them as the
resource_typeargument to the corresponding *_resource tools.Each value is a dict of fields:
Entries with a
typekey are attributes (e.g.String,Date,Object).isArray: trueindicates a list-valued attribute.Entries with a
linkkey are relationships. Thelinkvalue is the related resource type — pass it (or a comma-separated list) as theincludeargument to fetch related records inline.isArray: truemeans a to-many relationship;inverseis the field name on the other side.
Internal/system fields present on every type:
tenants,createdAt,updatedAtare managed by the platform. Do NOT include them in create/update payloads and do not surface them as user-facing data unless explicitly asked.
Read this resource before constructing filters, includes, or create/update payloads — it is the source of truth for valid types and field names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||