OSTicket Unofficial API

I'm trying to use this project on my osTicket installation, but i'm struggling to make it work.

I want to fetch data with a script written in R, using the jsonlite and httr libraries, but i'm not sure what's going wrong that keeps returning this:

"{\"status\":\"Error\",\"data\":\"Incorrect API Format\"}"

Here's my code:

library(jsonlite)
library(httr)

header_api <- c('apikey' = 'my_api_key')

call <- VERB(verb = "GET", 
                url = "https://url_to_my_osticket_root/upload/ost_wbs/", 
                config = add_headers(header_api), 
                body = '{
                        "query":"ticket",
                        "condition":"all",
                        "sort": "status",
                        "parameters":{
                            "status":0
                            }
                        }')

convert_rawdata <- content(call, "text")

Am I missing something? What "Incorrect API format" means? I'm passing the API key in the header as a string, following the documentation instructions.

I will be happy if someone helps me on this. Thanks!

I trying ost_wbs on the root osticket installation and configire config for database and premises table but i trying access query for detial specific ticket by ID/Ticket number not work.

My osticket trying version V latest version fail V.15.4.4 fail V.15.3.1 fail

So you can help me please...?

If i want to open a ticket, why so many mandatory fields ?

Can many of them be optional ?

for example , we dont use sla_id or priority_id , can it be for example =1 by default if its not in api ?

This is a great API and it's easy to add additional features. I wanted to have a way to include FAQ's from the knowledgebase and use the help topics in a contact form on my website.

I've also included an autoloader for the class files to make adding additional features quicker and a fix in the OSTicketAPI class that prevents errors when the sort and parameter attributes aren't used.

This also includes the variable name fix for class.ticket.php

API is excellent and easy to use. Many thanks for your great work

Issue Description: staff_id always returns "0" in json to fetch all tickets. Sample response: https://jsoneditoronline.org/#left=cloud.ee63bb970ff447899dc5725ccb1bf943

Please check. Thank You

Thank you for this excellent API! It's a great addition to osTicket and I appreciate your hard work on it.

I wanted to use an API to find all tickets that were last modified between two dates.

It is the same as getting tickets by creation date, but this uses when the ticket was last updated/modified.

The database column to sort by is lastupdate, instead of created.

Hi, I am using osticket version v1.16.2, php 8.0 and mysql 5.5.

I had made the changes as per your provided installation details.

I am getting error 404 on POST ADD api request and don't understand what might be the issue. But I am sure that its not related to api key as I am able to create tickets using the other url and different body parameters but the same api key(please see the screenshot 1 and 2) but I want to use other api features such as close, edit etc.

Hello! This API that you've made is great. The code is awesome. I'm not sure if these changes will be useful for you or others, but figured I'd let you take a look. Also, I'm not sure I've followed your style sufficiently, apologies for the hacks.

In general - I was wanting a couple things: first, to be able to add tickets from our CRM, and add a user if needed. So with these mods, we can first check if the user existed in OST, and if they didn't, add them automatically.

Second, the tickets from this API were not using the 'status' field in some views, and the title was displaying differently from manually created tickets. I added some insert queries to add form table data, where it seems those are stored? The result looks more 'complete' in my environment when reviewing tickets.

Finally, we wanted a way to add internal notes when a ticket is created from our CRM. It's a useful way to get agents up to speed, without having that info viewable. So, I added this via some new "optionalParameters" hacking...

Most other things were minor. Apologies for the 'spacing' changes, it seems my VIM does that automatically...

Thanks again for this project and all the best!

Queries in class.ticket.php were trying to join table thread_entry directly onto table ticket and was pulling inaccurate data. Needs to be joined onto the thread table first.