Zendesk Java Client

This is a Zendesk client implementation written in Java using AsyncHttpClient and Jackson.

Codeship Status for cloudbees/zendesk-java-client Maven Central

Quality Gate

Coverage Lines

Using the API

Start by creating a Zendesk instance

Zendesk zd = new Zendesk.Builder("https://{{your domain}}.zendesk.com")
        .setToken("...") // or .setPassword("...")

If you are behind a proxy, or want to otherwise control the lifecycle of the AsyncHttpClient instance you should pass that through to the builder too. If you don't pass an AsyncHttpClient instance to the builder it will create its own which will be closed by the Zendesk.close() method.

Where methods return paged data sets, an Iterable is returned that will lazy-fetch one page at a time until all records have been fetched, so e.g.

for (Ticket ticket: zd.getTickets()) {

will iterate through all tickets. Most likely you will want to implement your own cut-off process to stop iterating when you have got enough data.

Mailing lists


Here is the status of the various API components: