PHPackages uvdesk/api-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. uvdesk/api-bundle ActiveSymfony-bundle uvdesk/api-bundle ================= Easily integrate with your community helpdesk system using the uvdesk api bundle. v1.1.4(10mo ago)1819.8k↓13.3%15[26 issues](https://github.com/uvdesk/api-bundle/issues)MITPHPPHP ^7.2.5 || ^8.0 Since Jan 21Pushed 7mo ago8 watchersCompare [ Source](https://github.com/uvdesk/api-bundle)[ Packagist](https://packagist.org/packages/uvdesk/api-bundle)[ RSS](/packages/uvdesk-api-bundle/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (1)Versions (12)Used By (0) [ ![](https://camo.githubusercontent.com/c69c613593ee19d21a501366e3e58b5b5d15e982f2f90c751d4ca6b01e635f2b/68747470733a2f2f73332d61702d736f757468656173742d312e616d617a6f6e6177732e636f6d2f63646e2e75766465736b2e636f6d2f75766465736b2f62756e646c65732f7765626b756c64656661756c742f696d616765732f75766465736b2d776964652e737667)](https://www.uvdesk.com/en/) The API Bundle empowers integration developers to seamlessly interact with the UVDesk Community Helpdesk system using its robust RESTful API. It provides a comprehensive set of endpoints that allow external applications to perform key operations—such as creating, updating, and retrieving tickets, managing customers and agents and smooth integration with third-party platforms and custom systems. Installation ------------ [](#installation) This bundle can be easily integrated into any symfony application (though it is recommended that you're using [Symfony 4](https://symfony.com/4) as things have changed drastically with the newer Symfony versions). Before continuing, make sure that you're using PHP 8.1 or higher and have [Composer](https://getcomposer.org/) installed. To require the api bundle into your symfony project, simply run the following from your project root: ``` $ composer require uvdesk/api-bundle ``` After installing api bundle run the below command: ``` $ php bin/console doctrine:schema:update --force ``` Finally clear your project cache by below command(write prod if running in production environment i.e --env prod): ``` $ php bin/console cache:clear --env dev ``` API References -------------- [](#api-references) Use the below available apis to interact with your helpdesk system. Session: -------- [](#session) - POST **/api/v1/session/login** Authenticate user credentials and generate an access token in response to access helpdesk apis as the authenticated user. Headers: ``` { "Authorization": "Bearer AUTH_TOKEN" } ``` > To generate the required auth token, simply encode the user's **email** and **password** separated by a *colon* in base64 format, *i.e. base64\_encode("email:password")*. Sample Response: ``` { "success": true, "accessToken": "VBGLASXENR..." } ``` - POST **/api/v1/session/logout** Invalidates an authenticated user access token so that it can't be used anymore. Headers: ``` { "Authorization": "Bearer ACCESS_TOKEN" } ``` > **ACCESS\_TOKEN**: The api access token that was generated either using the session login api or directly from the dashboard. Sample Response: ``` { "status": true, "message": "Session token has been expired successfully." } ``` Tickets: -------- [](#tickets) More examples of ticket related apis can be found over [here](https://github.com/uvdesk/api-bundle/wiki/Ticket-Related-APIs). - GET **/tickets** Get a collection of all user accessible tickets. Headers: ``` { "Authorization": "Bearer ACCESS_TOKEN" } ``` > **ACCESS\_TOKEN**: The api access token that was generated either using the session login api or directly from the dashboard. Sample Response: ``` { "tickets": [ { "id": 1, "subject": "Support Request ...", "isCustomerView": false, "status": { "id": 1, "code": "open", "description": "Open", "colorCode": "#0056fc", "sortOrder": 1 }, "group": null, "type": { "id": 1, "code": "support", "description": "Support", "isActive": true }, "priority": { "id": 1, "code": "low", "description": "Low", "colorCode": "#2DD051" }, "formatedCreatedAt": "16-05-2023 12:55pm", "totalThreads": "0", "agent": { "id": 1, "email": "agent@example.com", "name": "Sample Agent", "firstName": "Sample", "lastName": "Agent", "isEnabled": true, "profileImagePath": null, "smallThumbnail": null, "isActive": true, "isVerified": true, "designation": null, "contactNumber": null, "signature": null, "ticketAccessLevel": null }, "customer": { "id": 2, "email": "customer@example.com", "name": "Sample Customer", "firstName": "Sample", "lastName": "Customer", "contactNumber": null, "profileImagePath": null, "smallThumbnail": null } } ], "pagination": { "last": 1, "current": 1, "numItemsPerPage": 15, "first": 1, "pageCount": 1, "totalCount": 1, "pageRange": 1, "startPage": 1, "endPage": 1, "pagesInRange": [ 1 ], "firstPageInRange": 1, "lastPageInRange": 1, "currentItemCount": 1, "firstItemNumber": 1, "lastItemNumber": 1, "url": "#page/replacePage" }, "userDetails": { "user": 1, "name": "Sample Agent" }, "agents": [ { "id": 1, "udId": 1, "email": "agent@example.com", "name": "Sample Agent", "smallThumbnail": null } ], "status": [ { "id": 1, "code": "open", "description": "Open", "colorCode": "#0056fc", "sortOrder": 1 }, { "id": 2, "code": "pending", "description": "Pending", "colorCode": "#FF6A6B", "sortOrder": 2 }, { "id": 3, "code": "answered", "description": "Answered", "colorCode": "#FFDE00", "sortOrder": 3 }, { "id": 4, "code": "resolved", "description": "Resolved", "colorCode": "#2CD651", "sortOrder": 4 }, { "id": 5, "code": "closed", "description": "Closed", "colorCode": "#767676", "sortOrder": 5 }, { "id": 6, "code": "spam", "description": "Spam", "colorCode": "#00A1F2", "sortOrder": 6 } ], "group": [ { "id": 1, "name": "Default" } ], "team": [], "priority": [ { "id": 1, "code": "low", "description": "Low", "colorCode": "#2DD051" }, { "id": 2, "code": "medium", "description": "Medium", "colorCode": "#F5D02A" }, { "id": 3, "code": "high", "description": "High", "colorCode": "#FA8B3C" }, { "id": 4, "code": "urgent", "description": "Urgent", "colorCode": "#FF6565" } ], "type": [ { "id": 1, "name": "support" } ], "source": { "email": "Email", "website": "Website" } } ``` --- License ------- [](#license) The API Bundle and libraries included within the bundle are released under released under the [OSL-3.0 license](https://github.com/uvdesk/api-bundle/blob/master/LICENSE.txt) ### Health Score 43 — FairBetter than 91% of packages Maintenance38 Infrequent updates — may be unmaintained Popularity38 Limited adoption so far Community14 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~198 days Recently: every ~254 days Total 11 Last Release 325d ago PHP version history (3 changes)v1.0.0PHP ^7.0 v1.0.4PHP ^7.3 || ^8.0 v1.1.0PHP ^7.2.5 || ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/503afb59b85df1854eb6c5686917c035a6a41d95e6fd8866ead07a7404ca1f4c?d=identicon)[Akshay Kumar](/maintainers/Akshay%20Kumar) --- Top Contributors [![papnoisanjeev](https://avatars.githubusercontent.com/u/42460055?v=4)](https://github.com/papnoisanjeev "papnoisanjeev (16 commits)") --- Tags create-ticketfetch-all-ticketsticket-managementtrash-ticketuvdesk-api-bundleview-ticket ### Embed Badge ![Health badge](/badges/uvdesk-api-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/uvdesk-api-bundle/health.svg)](https://phpackages.com/packages/uvdesk-api-bundle) ``` ### Alternatives [uvdesk/support-center-bundle UVDesk Community Helpdesk Customer Support Center Bundle 3538.3k](/packages/uvdesk-support-center-bundle)[uvdesk/mailbox-component The Mailbox component provides tools that allows your helpdesk to process tickets from multiple email sources. 2637.7k](/packages/uvdesk-mailbox-component)[uvdesk/automation-bundle UVDesk Community Help desk Automation Bundle 2237.9k](/packages/uvdesk-automation-bundle)[uvdesk/extension-framework UVDesk Community Helpdesk Extension Framework Bundle 1636.5k](/packages/uvdesk-extension-framework) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)