Realm icon

Realm

Interact with the Realm API

Actions11

Document → Get

AI-generated

Summary

Retrieve a document by ID from a specified Realm connector.

Inputs

  • connectorId (required) — Choose from the list, or specify an ID using an expression
  • documentId — The document's ID to retrieve
  • fieldsToInclude — The fields to include in the response
  • requestOptions — Request-level configuration (batching, proxy, timeout, SSL validation)

Output shape

The API response containing the requested document fields, shaped by the selected fieldsToInclude.

Returned data reflects the Realm API's document representation; unspecified fields are omitted by default.

Examples

Example 1: Get a single document by ID with default fields

connectorId = 'default', documentId = 'abc123', fieldsToInclude = ['id', 'title']

Example 2: Get a document with batching enabled for throttling

connectorId = 'myConnector', documentId = 'xyz789', requestOptions.batching.batchSize = 10, requestOptions.timeout = 5000

Discussion