Origami icon

Origami

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

Actions17

Instance → Get

AI-generated

Summary

Retrieve a single record (instance) from a specified entity by its unique Instance ID, returning either a readable, flat record or the raw API response.

Inputs

  • Entity Name or ID (required) — Select the entity to which the instance belongs, either from the list or by specifying its ID via expression.
  • Instance ID (required) — The unique _id of the record to retrieve.
  • Readable Output — Toggle whether to return a clean, flat object with human-readable field names (default true) or the raw API response.

Output shape

a single record as a JSON object

If the record exists, returns either a flattened object of fields with metadata (if readableOutput is true) or the raw API record. If no record matches, returns a JSON object with success: false and an error message in 'message'.

Examples

Example 1: Getting a single instance with readable output

Select entity by name or ID, provide instanceId, and leave Readable Output enabled (default). Results include flat fields with human-readable keys.

Example 2: Getting a single instance with raw API response

Select entity by name or ID, provide instanceId, and disable Readable Output. Results include the full nested API response object without transformation.

Links

Discussion