Read Organization Memberships

Overview

The Read Organization Memberships Snap retrieves organization membership records from your Zendesk instance, with filtering options by membership ID, user, or organization.

Each membership record is emitted as a separate document on the output view. An organization membership represents the association between a Zendesk user and an organization. Use the Max results field to limit the number of documents emitted.



  • 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 membership record is emitted as a separate document.
Learn more about Error handling.

Snap settings

Important: If this Snap encounters an error during execution, the exception is raised at the pipeline level rather than being routed to the error view. Ensure that error handling is configured at the pipeline level when using this Snap.
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 Organization Memberships
Filter mode

Dropdown list
Select the strategy for filtering the organization memberships to retrieve.
  • All Memberships: Select to retrieve all organization memberships visible to the authenticated account.
  • By ID: Select to retrieve a single membership record by its Zendesk membership ID. Requires the Membership ID field.
  • By User: Select to retrieve all organization memberships for a specific user. Requires the User ID field.
  • By Organization: Select to retrieve all memberships for a specific organization. Requires the Organization ID field.

Default value: All Memberships

Example: By User
Membership ID*

String/Expression

Appears when Filter mode is By ID.

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

Default value: None

Example: 445566778
User ID*

String/Expression

Appears when Filter mode is By User.

Enter the numeric Zendesk user ID to retrieve all organization memberships for this user.

Default value: None

Example: 123456789
Organization ID*

String/Expression

Appears when Filter mode is By Organization.

Enter the numeric Zendesk organization ID to retrieve all memberships for this organization.

Default value: None

Example: 112233445
Max results

Integer/Expression

Specify the maximum number of membership 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