Documentation

UVdesk - API Resource

What is the UVdesk Open Source API?

The UVdesk Open Source API follows REST (Representational State Transfer) principles, allowing third-party applications to perform various ticket-related operations such as fetching, creating, updating, and deleting tickets. It enables secure data sharing and system integration for advanced workflows.

This API provides comprehensive ticket details, including ticket ID, subject, status, priority, assigned groups, and more. Before using the API, you need to integrate the API bundle with your UVdesk project.

Steps to Integrate UVdesk API:

  1. Navigate to the UVdesk Dashboard → Settings → API as shown below.

  2. Access API tokens by navigating to the API section and clicking on "Access Credentials".

  3. Provide a name for the token, enable it, and click "Save Credentials".

  4. After saving, your access token will be generated and displayed along with its creation date. You can also disable or delete tokens as needed.