API Documentation

Integrate with our platform using our comprehensive REST API. Build custom applications, automate workflows, and extend functionality.

Quick Start

Base URL

https://api.servicedesk.com

Authentication

Use Bearer token authentication with your API key

Rate Limits

1,000 requests per hour for most endpoints

Get API Key

Authentication

All API requests require authentication using your API key

Authorization: Bearer YOUR_API_KEY

Include your API key in the Authorization header of all requests. You can generate API keys in your account settings.

API Endpoints

Available endpoints for ticket management and other operations

GET
/api/tickets
Required
1000/hour

Retrieve all tickets

POST
/api/tickets
Required
100/hour

Create a new ticket

GET
/api/tickets/{id}
Required
1000/hour

Get a specific ticket

PUT
/api/tickets/{id}
Required
100/hour

Update a ticket

DELETE
/api/tickets/{id}
Required
50/hour

Delete a ticket

Code Examples

Examples in popular programming languages

// Get all tickets
const response = await fetch('https://api.servicedesk.com/api/tickets', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const tickets = await response.json();

// Create a new ticket
const newTicket = await fetch('https://api.servicedesk.com/api/tickets', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    subject: 'New support request',
    description: 'I need help with...',
    priority: 'medium',
    category: 'technical'
  })
});

Webhooks

Receive real-time notifications when events occur

Webhooks allow you to receive real-time notifications when events occur in your account. Configure webhook endpoints to receive POST requests with event data.

Available Events:

  • • ticket.created - When a new ticket is created
  • • ticket.updated - When a ticket is updated
  • • ticket.closed - When a ticket is closed
  • • message.created - When a new message is added
  • • user.created - When a new user is created

SDK Libraries

Official SDKs for popular programming languages

JavaScript/Node.js

Official SDK for JavaScript and Node.js

View on GitHub

Python

Official SDK for Python

View on PyPI

PHP

Official SDK for PHP

View on Packagist

Java

Official SDK for Java

View on Maven

Ready to Get Started?

Generate your API key and start integrating with our platform today