Read Users

Overview

The Read Users Snap retrieves user records from your Zendesk instance, with filtering options by user ID, group, organization, or role.

Each user record is emitted as a separate document on the output view. When no filter is applied, all users visible to the authenticated account are returned. Use the Max results field to limit the number of documents emitted. When Filter mode is Self, a single document is returned for the currently authenticated user and Max results is ignored.



  • 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 user 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 Users
Filter mode

Dropdown list
Select the strategy for filtering the users to retrieve.
  • All Users: Select to retrieve all users visible to the authenticated account.
  • Self: Select to retrieve the currently authenticated user as a single document. When selected, the Max results field is ignored.
  • By ID: Select to retrieve a single user by their Zendesk user ID. Requires the User ID field.
  • By Group: Select to retrieve all users in a specific group. Requires the Group ID field.
  • By Organization: Select to retrieve all users in a specific organization. Requires the Organization ID field.
  • By Role: Select to retrieve all users with a specific role. Requires the Role field.

Default value: All Users

Example: By Group
User ID*

String/Expression

Appears when Filter mode is By ID.

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

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 users in that group.

Default value: None

Example: 987654321
Organization ID*

String/Expression

Appears when Filter mode is By Organization.

Enter the numeric Zendesk organization ID to retrieve all users in that organization.

Default value: None

Example: 112233445
Role*

String/Expression

Appears when Filter mode is By Role.

Enter the Zendesk role to filter users by. Valid values:
  • end-user
  • agent
  • admin

Default value: None

Example: agent
Max results

Integer/Expression

Enter the maximum number of user records to emit per execution. Enter 0 or leave empty to emit all matching results. This field is ignored when Filter mode is Self.

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