Search Custom Object Records

zendesk/search-custom-object-records — Search custom object records by query string.

Where it appears

The Search Custom Object Records block lives in the Integrations group of the Workflow Builder. Connect the Zendesk integration before adding it.

Fields

Field	Type	Required	Default	Description
`customObjectKey`	text (supports references)	Yes	—	The key of the Zendesk custom object type to search within (e.g. `home_delivery_order`). Accepts literal text or <StepName.field>.
`query`	text (supports references)	Yes	—	Free-text query matched against the custom object records. Accepts literal text or <StepName.field> from a previous step.
`sort`	text (supports references)	No	—	Optional sort field; prefix with `-` for descending order (e.g. `-updated_at`). Accepts literal text or <StepName.field>.
`pageSize`	text (supports references)	No	—	Optional number of records to return per page. Accepts a literal number or <StepName.field>.

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <Search Custom Object Records.field>.

Name	Type	Description
`success`	boolean	Success status
`records`	array	Matching custom object records
`count`	number	Total matching records
`error`	string	Error message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/search-custom-object-records",
  "config": {
    "customObjectKey": "<PreviousStep.field>",
    "query": "<PreviousStep.field>"
  }
}

Limits and failure modes

Requires a connected Zendesk integration. Calls fail if that integration is disconnected or its authorization has expired.
Required fields (customObjectKey, query) must be set, or the block fails validation before it runs.
On failure the error output is populated; downstream blocks that reference other outputs may not receive values.