Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidocs.neetodesk.com/llms.txt

Use this file to discover all available pages before exploring further.

The NeetoDesk API is organized around REST principles and uses standard HTTP response codes. All API endpoints return JSON responses and require authentication. Before you start with NeetoDesk APIs you will need the following:
  1. Workspace Subdomain
  2. An API key

​
Quick start

Get started with the NeetoDesk API in minutes. Make your first API call and create your first ticket. You should have your API key and Workspace Subdomain ready with you.

​
Step 1: Make Your First API Call

Let’s create a ticket in your workspace using a POST request: 
curl -X POST "https://{your-subdomain}.neetodesk.com/api/v1/public/tickets" \
  -H 'X-Api-Key: your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "customer@example.com",
    "subject": "My first API ticket",
    "description": "This ticket was created using the NeetoDesk API!"
  }'
Replace your-subdomain with your workspace subdomain and your-api-key with your actual API key.

​
Step 2: Understanding the Response

A successful response will look like this JSON format: 
{
  "notice_code": "ticket_created_successfully",
  "ticket": {
    "id": "aaaabbbb-cccc-dddd-eeee-ffff00003333",
    "number": 42,
    "url": "https://{your-subdomain}.neetodesk.com/admin/tickets/42",
    "subject": "My first API ticket",
    "description": "This ticket was created using the NeetoDesk API!",
    "status": "open",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

​
Next Steps

Now that you’ve made your first API call, you can:

Explore API reference

Browse available endpoints and their detailed documentation.

Pagination

Understand how to paginate through API responses efficiently.

HTTP response codes

Learn what different response codes mean and how to handle them.

Need Help?

Visit our help center or contact us by sending an email to support@neetodesk.com.