Jump to Content

Getting Started API Guide Knowledge base Get Started

Home Getting Started API Guide

v1.0

Getting Started API Guide Knowledge base Get Started Home

v1.0Home Getting Started API Guide

Introduction

Introduction
Authentication

Cases

Create / Update a Casepost
Update Statuspost
Assign to Agent or Queuepost
Returning a Caseget
Return Casespost
Return Categoriesget
Return Prioritiesget
Return Issuesget
Return Outcomesget
Returning On Open Policyget
Returning View Policyget
Returning On Close Policyget
Case Object
Activity Object
Attachment Object
Field Object
Policy Object

Activity

Create an Activitypost
Returning an Activityget
Return Activitiespost
Return Typesget
Upload Attachment (HTML5 Form)post
Delete Attachmentdelete
Activity Object
Attachment Object

Company

Create / Update Companypost
Return a Companyget
Search for Company by Nameget
Company Object
Field Object
Search for Customerget

Contact

Create / Update Contactpost
Return a Contactget
Search for Contact by Nameget
Company Contactsget
Contact Object
Field Object

Asset

Create / Update Assetpost
Return an Assetget
Search for Assets by Nameget
Asset Object
Field Object

Article

Create / Update Articlepost
Returning an Articleget
Article Object
Attachment Object
Field Object
Container Object

User

User Countspost
User Notificationsget
User Notifications Since X Datepost
Add History Itempost
User Historyget
User Notification Deletedelete
User Work Queuesget
User Listget

Calendar

Calendar Eventspost

Queue

Queue Listget
Return Statesget

Custom Fields

Fieldspost
Return Dropdown Itemsget

Email

From Email Address Listget
Default Email Addressget

Attachment

Delete Temporary Attachmentdelete
Delete Activity Attachmentdelete

Support Level

Return Support Levelsget

DATATABLES

List of Data Tablesget
Table Datapost

Introduction

Introduction
Authentication

Cases

Create / Update a Casepost
Update Statuspost
Assign to Agent or Queuepost
Returning a Caseget
Return Casespost
Return Categoriesget
Return Prioritiesget
Return Issuesget
Return Outcomesget
Returning On Open Policyget
Returning View Policyget
Returning On Close Policyget
Case Object
Activity Object
Attachment Object
Field Object
Policy Object

Activity

Create an Activitypost
Returning an Activityget
Return Activitiespost
Return Typesget
Upload Attachment (HTML5 Form)post
Delete Attachmentdelete
Activity Object
Attachment Object

Company

Create / Update Companypost
Return a Companyget
Search for Company by Nameget
Company Object
Field Object
Search for Customerget

Contact

Create / Update Contactpost
Return a Contactget
Search for Contact by Nameget
Company Contactsget
Contact Object
Field Object

Asset

Create / Update Assetpost
Return an Assetget
Search for Assets by Nameget
Asset Object
Field Object

Article

Create / Update Articlepost
Returning an Articleget
Article Object
Attachment Object
Field Object
Container Object

User

User Countspost
User Notificationsget
User Notifications Since X Datepost
Add History Itempost
User Historyget
User Notification Deletedelete
User Work Queuesget
User Listget

Calendar

Calendar Eventspost

Queue

Queue Listget
Return Statesget

Custom Fields

Fieldspost
Return Dropdown Itemsget

Email

From Email Address Listget
Default Email Addressget

Attachment

Delete Temporary Attachmentdelete
Delete Activity Attachmentdelete

Support Level

Return Support Levelsget

DATATABLES

List of Data Tablesget
Table Datapost

Introduction

Supportbench is a customer support and helpdesk platform. Many customers use the Supportbench API in order to create custom workflows or integrations with internal systems.