How to access the Ticket System REST API

This article describes how to access the REST-API of the Open-Xchange Helpdesk

Preparing Token Access

Being able to access the Ticketsystem's REST-API, it requires a Ticketsystem user to create an individual Access Token. This can be done via User -> Profile -> Token Access


Official API

The vendor's official API documentation for the ticket system software can be found at https://docs.zammad.org/en/latest/api/intro.html

Open-Xchange Help Desk Systems

Production Environment

The URL for the Production Environment is
https://helpdesk.open-xchange.com

Staging Environment

The URL for the Staging Environment is
https://helpdesk-staging.open-xchange.com

Important:
Both systems use their own credentials store and are not synchronised.

Beside of the generic API specification of the vendor there are some OX specifics which need to be taken care of. These are e.g. the
For more information please see the user documentation: https://user-docs.zammad.org/en/latest/