Developer platform · API v1

Build with the FastHelpdesk API.

Read the live demo database through a typed, versioned API. Selected integration writes are implemented behind bearer-token authentication.

Open Swagger UIOpen ReDocDownload swagger.jsonView on GitHub
Public preview access. GET endpoints require no authentication. Writes return 503 until FASTSME_API_TOKEN is configured; enabled clients send Authorization: Bearer <token>.

Resources

Tickets

Customer support tickets and SLA workflow state.

GET /api/v1/ticketsGET /api/v1/tickets/{id}

Customers

Support customer organisations.

GET /api/v1/customersGET /api/v1/customers/{id}

Knowledge articles

Published and draft support knowledge.

GET /api/v1/knowledgeGET /api/v1/knowledge/{id}

Canned responses

Reusable agent response templates.

GET /api/v1/canned-responsesGET /api/v1/canned-responses/{id}

Quick start

curl "https://helpdesk.fastsme.com/api/v1/tickets?limit=20"

python - <<'PY'
import requests
rows = requests.get("https://helpdesk.fastsme.com/api/v1/tickets", timeout=20).json()
print(rows["data"])
PY

Runtime OpenAPI: /api/openapi.json · Stable compatibility schema: /swagger.json · Interactive docs: /api/docs