(English) API Resource | UVdesk Open Source Helpdesk

Updated 27 December 2021

Facebook Linkedin
. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


  • Andrea Costa
    Looks nice! I did some test, creating, listing ticket, everything ok… but I got the following error on: POST /api/v1/ticket/2/thread

    Here is the curl command:

    curl -v -H «Authorization: Basic N1RA8J7OQNZBO0WJD0WV73U5TX1HNODBQDKAXYBWELQUE5NKYXQNMAB9CEFNNTDL» -H «Content-Type: application/json» -d ‘{«message»:»Messaggio di risposta», «actAsEmail»:»mario.rossi@superfattura.it», «actAsType»:»customer», «threadType»: «reply»}’ -X POST http://localhost/api/v1/ticket/2/thread
    Note: Unnecessary use of -X or —request, POST is already inferred.
    % Total % Received % Xferd Average Speed Time Time Time Current
    Dload Upload Total Spent Left Speed
    0 0 0 0 0 0 0 0 —:—:— —:—:— —:—:— 0* Trying…
    * Connected to localhost ( port 80 (#0)
    > POST /api/v1/ticket/2/thread HTTP/1.1
    > Host: localhost
    > User-Agent: curl/7.69.1
    > Accept: */*
    > Content-Type: application/json
    > Content-Length: 126
    } [126 bytes data]
    * upload completely sent off: 126 out of 126 bytes
    * Mark bundle as not supporting multiuse
    < HTTP/1.1 500 Internal Server Error
    < Server: nginx
    < Date: Mon, 11 May 2020 16:02:36 GMT
    < Content-Type: application/json
    < Content-Length: 82
    < Connection: keep-alive
    < Vary: Authorization
    < Set-Cookie: PHPSESSID=k9cvfd8j2ali4grvu52n8b1fla; path=/; HttpOnly; SameSite=lax
    < Cache-Control: max-age=0, must-revalidate, private
    < Access-Control-Allow-Origin: *
    < Access-Control-Allow-Methods: GET,POST,PUT,OPTIONS
    < Access-Control-Allow-Headers: Access-Control-Allow-Origin
    < Access-Control-Allow-Headers: Authorization
    < Access-Control-Allow-Headers: Content-Type
    < pragma: no-cache
    < Expires: Mon, 11 May 2020 16:02:36 GMT
    < X-Debug-Token: 322b1d
    < X-Debug-Token-Link: http://localhost/_profiler/322b1d
    < X-Robots-Tag: noindex
    { [82 bytes data]
    100 208 100 82 100 126 245 377 —:—:— —:—:— —:—:— 626{"status":false,"message":"An unexpected error occurred. Please try again later."}
    * Connection #0 to host localhost left intact

    Thank you

    • Himani Gupta
      Hello Andrea Costa,
      Nice day to you!!
      Have you tried the same with the Postman? Kindly try it via postman and let us know if it still exists?
      Thanks for using our community software and your effort.
      Kind Respects
      UVdesk Team
  • Arunachalam

    In the uvDESK community edition, after configuring the API following this doc https://www.uvdesk.com/en/blog/api-resource/ and when accessing through the postman got this error in the dev.log file.

    [2020-08-01 01:07:51] request.INFO: Matched route «uvdesk_api_bundle_api_tickets_v1.0_fetch_tickets». {«route»:»uvdesk_api_bundle_api_tickets_v1.0_fetch_tickets»,»route_parameters»:{«_route «:»uvdesk_api_bundle_api_tickets_v1.0_fetch_tickets»,»_controller»:»Webkul\\UVDesk\\ApiBundle\\API\\Tickets::fetchTickets»},»request_uri»:» c/api/v1/tickets»,»method»:»GET»} []
    [2020-08-01 01:07:51] security.DEBUG: Checking for guard authentication credentials. {«firewall_key»:»uvdesk_api»,»authenticators»:1} []
    [2020-08-01 01:07:51] security.DEBUG: Checking support on guard authenticator. {«firewall_key»:»uvdesk_api»,»authenticator»:»Webkul\\UVDesk\\ApiBundle\\Security\\Guards\\APIGuard»} []
    [2020-08-01 01:07:51] security.DEBUG: Calling getCredentials() on guard authenticator. {«firewall_key»:»uvdesk_api»,»authenticator»:»Webkul\\UVDesk\\ApiBundle\\Security\\Guards\\APIGuard»}

    The postman response windows got this error..

    «status»: false,
    «message»: «An unexpected error occurred. Please try again later.»

    What could be the issue ? How to debug furthur ?


    • Komal Sharma
      Hello Arunachalam,

      We have checked but we are not able to reproduce like this issue in API bundle. Let us know if it still exists? Can you please share your composer.json and composer.lock file. You can please share on the our official uvdesk forums. Please follow the below link:


      Also, you can create a ticket on our support helpdesk from here:


      Kind Respects
      UVdesk Team

  • Joseph
    Please fix this page — https://www.uvdesk.com/en/api-doc/. The contents do not show when you click the menu. Thanks.
    • Himani Gupta
      Hello Joseph
      Above shared page is working as expected. You can visit this page effortlessly and get the API of SaaS(cloud-based) helpdesk — uvdesk
      Thanks & Regards
      UVdesk Team
  • leo

    Thank you so much about the informations but where is the last updated API documentation ?

    The doc online is totaly different : https://www.uvdesk.com/en/api-doc/


  • Alexandre Bueno
    It follows the procedures, but when clicking to generate the key it gave this error. Can you help me?

    {«status»:false,»message»:»Invalid credentials provided.»,»error_code»:»API-002″}

  • css.php