omnidesk
  • Ticket
    • Message
    • Using forms
    • Contact forms
  • Customers
    • General
    • API sync on contact
    • CSV import
    • API sync before contact
    • Customer lookup
  • Telephone
    • Callflow
    • Numbers
  • E-mail
  • Users
  • Live chat
    • Livechat chatbot and app integration (backend)
  • Facebook
  • Twitter
  • Survey
    • Push data
  • Statistics
    • Statistics API
  • Raw data - BI
  • Security policy
  • Hosting
  • API docs
    • General
    • Authentication
    • REST
  • API specification
    • Documentation for the Omnidesk API endpoints
    • Chat
    • Customer
    • Email
    • Form
    • Formfield
    • Message
    • Notification
    • Raw
    • Statisticsv2
    • Ticket
    • User
    • View
Powered by GitBook
On this page
  1. API docs

Authentication

In your omnidesk application a key can be created to which certain permissions will be granted. You could for instance assign customer creation and deletion to a key. Most permissions are devided in two categories: READ permissions and CUD (create update delete) permissions for a given endpoint. Once you have created a key and given it permissions you will be able to authenticate with it by sending ?apiKey=[[ your key ]] in the API url.

An example would be: https://account.omnidesk.com/api/v2/customer?apiKey=14fasf35435sdgsdgksjh235. Since this is a GET request for the customer endpoint it will list all customers, limited by paging.

PreviousGeneralNextREST

Last updated 1 year ago