Reference

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 Required Options
Name: organization_ids

Label: Organization ID(S) - Use Comma for multiple (e.g. 111,222)

 YES

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
$$organization_ids DT_WSTR nvarchar(2000) 2000
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
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
Organizations
Required Parameters
Organization ID(S) - Use Comma for multiple (e.g. 111,222) Fill-in the parameter...
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 organization by id:

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
Organizations
Lookup
Required Parameters
Organization ID(S) - Use Comma for multiple (e.g. 111,222) Fill-in the parameter...
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).