Reference

Endpoint Read User Fields


Name

get_user_fields

Description

Returns a list of custom User Fields in your account. Fields are returned in the order that you specify in your User Fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the user_fields attribute on the User resource. [API reference]

Parameters

Parameter Required Options
Name: Filter

Label: Filter

Option Value
all fields $.user_fields[*]
date fields $.user_fields[?(@type=='date')]

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Zendesk Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Zendesk
Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
Zendesk
Read User Fields
Optional Parameters
Filter $.user_fields[*]
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Zendesk
Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
Zendesk
Read User Fields
Optional Parameters
Filter $.user_fields[*]
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Read user fields

SELECT * FROM get_user_fields

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read user fields

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_user_fields';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];