Install

Install using npm:

npm install zendesk-client

API Documentation

Zendesk Core API

Quick Start

import createClient from 'zendesk-client';

const client = createClient({
  token : 'token',
  url   : 'https://[yoursubdomain].zendesk.com',
});

client.search.query('type:ticket status:open status:new')
.then((result) =>{
  console.log(result)
})
.catch((error)=>{
  console.log(error)
});

Attachments

client.attachments

upload(files)

Tickets

client.tickets

list()
listByOrganization(orgId)
listByUserRequested(userId)
listByUserCCD(userId)
listByAssigned(userId)
listRecent()
show(ticketId)
showMany(ticketIds)
create(ticket)
createMany(tickets)
update(ticketId, ticket)
updateMany(ticketIds, ticket)
delete(ticketId)
deleteMany(ticketIds)
getComments(ticketId)

Search

client.search

query(searchTerm)

Users

client.users

list()
listByGroup(groupId)
listByOrganization(orgId)
show(userId)
showMany(userIds)
me()

OauthTokens

client.oauthtokens

list()
show(id)
current()