Read Group Memberships

Overview

The Read Group Memberships Snap retrieves group membership records from your Zendesk instance, with filtering options by membership ID, user, group, or assignable scope.

Each membership record is emitted as a separate document on the output view. A group membership represents the association between a Zendesk agent and a group. Use the Assignable filter mode to retrieve only memberships for groups that can be assigned to tickets. 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 group membership 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 Group Memberships
Filter mode

Dropdown list
Select the strategy for filtering the group memberships to retrieve.
  • All Memberships: Select to retrieve all group memberships visible to the authenticated account.
  • Assignable: Select to retrieve only memberships for groups that can be assigned to tickets.
  • 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 group memberships for a specific user. Requires the User ID field.
  • By Group: Select to retrieve all memberships for a specific group. Requires the Group ID field.

Default value: All Memberships

Example: By Group
Membership ID *

String/Expression

Appears when Filter mode is By ID.

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

Default value: None

Example: 556677889
User ID *

String/Expression

Appears when Filter mode is By User.

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

Default value: None

Example: 123456789
Group ID *

String/Expression

Appears when Filter mode is By Group.

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

Default value: None

Example: 987654321
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: 0

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