Endpoint

Read Organization(s) by ID

Name

get_organizations_by_ids

Description

Get a list of organizations in your account for specific id(s) [API reference]

Related Tables

Organizations

Parameters

Parameter	Label	Required	Options	Description
organization_ids	Organization ID(S) - Use Comma for multiple (e.g. 111,222)	YES

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
name	`DT_WSTR`	`nvarchar(500)`	500	`False`
notes	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
created_at	`DT_DBTIMESTAMP`	`datetime`		`False`
details	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
domain_names	`DT_WSTR`	`nvarchar(144)`	144	`False`
domain_names_1	`DT_WSTR`	`nvarchar(255)`	255	`False`
domain_names_2	`DT_WSTR`	`nvarchar(255)`	255	`False`
domain_names_3	`DT_WSTR`	`nvarchar(255)`	255	`False`
external_id	`DT_WSTR`	`nvarchar(500)`	500	`False`
group_id	`DT_I8`	`bigint`		`False`
shared_comments	`DT_BOOL`	`bit`		`False`
shared_tickets	`DT_BOOL`	`bit`		`False`
tags	`DT_WSTR`	`nvarchar(144)`	144	`False`
tags_1	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_2	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_3	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_4	`DT_WSTR`	`nvarchar(500)`	500	`False`
tags_5	`DT_WSTR`	`nvarchar(500)`	500	`False`
updated_at	`DT_DBTIMESTAMP`	`datetime`		`False`
url	`DT_WSTR`	`nvarchar(500)`	500	`False`
organization_field_dt_[$parent.key$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
organization_field_[$parent.key$]	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

If the column you are looking for is missing, consider customizing Zendesk Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
id	`DT_I8`	`bigint`		`False`
name	`DT_WSTR`	`nvarchar(500)`	500	`False`
notes	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
external_id	`DT_WSTR`	`nvarchar(500)`	500	`False`
group_id	`DT_I8`	`bigint`		`False`
details	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
tags	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
organization_fields	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
domain_names	`DT_WSTR`	`nvarchar(1000)`	1000	`True`
shared_comments	`DT_BOOL`	`bit`		`False`
shared_tickets	`DT_BOOL`	`bit`		`False`
$$organization_ids	`DT_WSTR`	`nvarchar(2000)`	2000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Zendesk Connector in API Source component to read data or in API Destination component to read/write data:

Lookup a row in Organizations table using API Destination

This Endpoint belongs to Organizations table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Zendesk

Organizations

Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get multiple organizations by ID(s)

Read multiple organization information from Zendesk by ID(s)

SELECT * from get_organizations_by_ids
WITH(organization_ids='1111,2222,3333')

get_organizations_by_ids 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:

Get multiple organizations by ID(s)

Read multiple organization information from Zendesk by ID(s)

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * from get_organizations_by_ids
WITH(organization_ids=''1111,2222,3333'')';

EXEC (@MyQuery) AT [LS_TO_ZENDESK_IN_GATEWAY];

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