Read Organizations

Overview

The Read Organizations Snap retrieves organization records from your Zendesk instance, with filtering options by organization ID or external ID.

Each organization record is emitted as a separate document on the output view. When no filter is applied, all organizations visible to the authenticated account are returned. Use the Max results field to limit the number of documents emitted. When Filter mode is By External ID, results are fetched in a single call and Max results is applied after the fact, not during retrieval.



  • This is a Read-type Snap.
  • Does not support Ultra Tasks

Supported Accounts

Prerequisites

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

When connected, field values from the incoming document can be referenced in expression-enabled fields using the $ notation.
Output

This Snap has one document output view.

Each Zendesk organization record is emitted as a separate document.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Read Organizations
Filter mode

Dropdown list
Select the strategy for filtering the organizations to retrieve.
  • All Organizations: Select to retrieve all organizations visible to the authenticated account.
  • By ID: Select to retrieve a single organization by its Zendesk organization ID. Requires the Organization ID field.
  • By External ID: Select to retrieve organizations matching the external ID assigned in your own system. Unlike other modes, this is not cursor-paginated — all matching records are fetched in a single call. Requires the External ID field.

Default value: All Organizations

Example: By ID
Organization ID *

String/Expression

Appears when Filter mode is By ID.

Enter the numeric Zendesk organization ID of the organization to retrieve.

Default value: None

Example: 112233445
External ID *

String/Expression

Appears when Filter mode is By External ID.

Enter the external ID assigned to the organization in your own system. This is a value you set when creating or updating the organization in Zendesk.

Default value: None

Example: ext-org-001
Max results

Integer/Expression

Specify the maximum number of organization records to emit per execution. Enter 0 or leave empty to emit all matching results.

Default value: None

Example: 10
Retry attempts

Integer/Expression

Enter the number of times the Snap should retry the API call on connection errors or 5xx responses. On a 429 response, the Snap automatically retries after the interval specified in the server's Retry-After header, overriding the Retry interval value. On a 401 response, the Snap reloads the account credentials and retries before counting the attempt against this limit.

Default value: 5

Example: 3
Retry interval (seconds)

Integer/Expression

Enter the number of seconds to wait between retry attempts.

Default value: 3

Example: 5

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Validate & execute