Skip to main content
GET
/
tickets
List all tickets
curl --request GET \
  --url https://{your-workspace}.neetodesk.com/api/v1/public/tickets \
  --header 'X-Api-Key: <x-api-key>'
{
  "tickets": [
    {
      "id": "<string>",
      "number": 123,
      "subject": "<string>",
      "description": "<string>",
      "priority": "<string>",
      "status": "<string>",
      "category": "<string>"
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

​
page_number
integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

​
status
string

Filter tickets by their status. Accepts comma-separated values for multiple statuses. Default statuses include: new, open, waiting_on_customer, on_hold, closed, spam, trash. Custom statuses created in your organization are also supported. If omitted, tickets of all statuses are returned.

Example:

"open"

Response

200 - application/json

OK - Request succeeded

​
tickets
object[]
​
pagination
object
⌘I