Reference

Endpoint Read Organizations (All)

Name

get_organizations

Description

Get a list of all organizations in your account [API reference]

Related Tables

Organizations

Parameters

Parameter Required Options
Name: PageSize

Label: Records Per Page (Max 100)

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
id DT_I8 bigint
name DT_WSTR nvarchar(500) 500
notes DT_WSTR nvarchar(4000) 4000
created_at DT_DBTIMESTAMP datetime
details DT_WSTR nvarchar(4000) 4000
domain_names DT_WSTR nvarchar(144) 144
domain_names_1 DT_WSTR nvarchar(255) 255
domain_names_2 DT_WSTR nvarchar(255) 255
domain_names_3 DT_WSTR nvarchar(255) 255
external_id DT_WSTR nvarchar(500) 500
group_id DT_I8 bigint
shared_comments DT_BOOL bit
shared_tickets DT_BOOL bit
tags DT_WSTR nvarchar(144) 144
tags_1 DT_WSTR nvarchar(500) 500
tags_2 DT_WSTR nvarchar(500) 500
tags_3 DT_WSTR nvarchar(500) 500
tags_4 DT_WSTR nvarchar(500) 500
tags_5 DT_WSTR nvarchar(500) 500
updated_at DT_DBTIMESTAMP datetime
url DT_WSTR nvarchar(500) 500
organization_field_dt_[$parent.key$] DT_WSTR nvarchar(4000) 4000
organization_field_[$parent.key$] DT_WSTR nvarchar(4000) 4000
If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
id DT_I8 bigint
name DT_WSTR nvarchar(500) 500
notes DT_WSTR nvarchar(4000) 4000
external_id DT_WSTR nvarchar(500) 500
group_id DT_I8 bigint
details DT_WSTR nvarchar(4000) 4000
tags DT_WSTR nvarchar(4000) 4000
organization_fields DT_WSTR nvarchar(4000) 4000
domain_names DT_WSTR nvarchar(1000) 1000
shared_comments DT_BOOL bit
shared_tickets DT_BOOL bit
Required columns that you need to supply are bolded.

Examples

SSIS

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

API Source

This Endpoint belongs to the Organizations table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Zendesk
Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.
Zendesk
Organizations
Optional Parameters
NextUrlAttributeOrExpr $.links.next
Records Per Page (Max 100) 100
NextUrlEndIndicator false
StopIndicatorAttributeOrExpr $.meta.has_more
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Organizations table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to read organizations:

API Destination - Zendesk
Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.
Zendesk
Organizations
Select
Optional Parameters
NextUrlAttributeOrExpr $.links.next
Records Per Page (Max 100) 100
NextUrlEndIndicator false
StopIndicatorAttributeOrExpr $.meta.has_more
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read organizations

<p>Reads all organizations from the Zendesk account. This example demonstrates querying the <code>Organizations</code> table. You can optionally filter by ID using the <code>WHERE</code> clause.</p> 

SELECT * FROM Organizations --Where Id=1234

get_organizations endpoint belongs to Organizations table(s), and can therefore be used via those table(s).

SQL Server

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

Read organizations

<p>Reads all organizations from the Zendesk account. This example demonstrates querying the <code>Organizations</code> table. You can optionally filter by ID using the <code>WHERE</code> clause.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Organizations --Where Id=1234';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

get_organizations endpoint belongs to Organizations table(s), and can therefore be used via those table(s).