Origami icon

Origami

Interact with the Origami CRM API | Developed for the community by OTE CONNECT

Actions17

Entity → Get Structure

AI-generated

Summary

Retrieve the complete schema of a specified entity, including field groups, field names, data names, types, and validation rules.

Inputs

  • Entity Name or ID (required) — Select an entity from the list or specify its ID using an expression to fetch its structure schema.

Output shape

a single JSON object containing the full entity structure with field groups and fields metadata

The returned structure includes detailed schema information useful for discovering field_data_name and group_data_name values needed for Create or Update operations. The output is the direct API response in JSON format without transformation.

Examples

Example 1: Fetch structure of a customer entity

Entity: customer_entity_id

Links

Discussion