Get Started

The Viadesk API is open to our customers. Currently, a subset of our extensive API is public. Please let us know if you need something in particular!


  • Simply pass your Viadesk username (email) and password in the “Authorization” request header, using the “Basic” authentication scheme.
  • Permissions/roles are automatically inherited


  • All API requests must be made over SSL/HTTPS. Calls over plain HTTP will fail.
  • URL naming convention: https://{yourViadeskServer}/api/{apiEndpoint}.json
  • Setting the user language with a cookie (optional):
    Cookie: locale=nl_NL
    Cookie: locale=en_US


  • Data is returned in JavaScript Object Notation, where dates ISO8601 formatted.
  • Fields with empty, zero or null values may be omitted in the JSON string.

HTTP methods
Use appropriate HTTP methods to indicate the type of action:

  • GET to obtain an object. Supply arguments as query string.
  • POST to write (create, update) an object. Supply arguments as application/x-www-form-urlencoded form data or multipart/form-data form data.
  • PUT to upload or replace files. Supply arguments as query string, the uploaded file is the request body.
  • DELETE to delete an object. Supply arguments as query string.


HTTP response codes

  • The API uses conventional HTTP response codes to indicate success or failure of a request.
  • In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, there was no permission, etc.), and codes in the 5xx range indicate an error with our servers.

List of End Points >