crm

Search bounded pages of readable CRM entries, optionally projecting cells. Always follow continueCursor until isDone

Search bounded pages of readable CRM entries, optionally projecting cells. Always follow continueCursor until isDone.

get/crm/search/page

Request

  • Base URL
    https://www.dench.com/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

withReferencesboolean

Include bounded navigation references. Array reads return {data, references, referenceCoverage}; existing result envelopes keep their fields.

textstring required

Full-text query over readable entries.

objectNamestring
selectstring[]
selectionMode'strict' | 'compact'

Defaults to strict. Explicit modes require objectName and select. Compact recovers unknown selected names with bounded canonical columns and explicit selectionFallback metadata in the same response. Does not guess aliases.

limitinteger
cursorstring

Use the preceding continueCursor, with the same query and projection.

filterJsonstring

A query-DSL filter as JSON, applied to each page as crm query applies it (requires objectName). A filtered page can be empty while more remain.

timeZonestring

IANA zone the filter's dates mean (requires objectName).

Response

Successful response

isDoneboolean required
continueCursorstring nullable required
returnedCountnumber required
selectedFieldsstring[] nullable required
completeness'page' required

Changes

No recorded changes to this operation across all 1 revision of this API.